Compare commits

...

91 Commits

Author SHA1 Message Date
Wolfgang Kulhanek
d0d51b02f6 More formatting 2025-10-23 14:30:30 +02:00
Wolfgang Kulhanek
1bec5957b9 Formatting? 2025-10-23 14:29:42 +02:00
Wolfgang Kulhanek
95ea4ac54f Formatting 2025-10-23 14:28:00 +02:00
Wolfgang Kulhanek
cba84f669a Add source tag 2025-10-23 14:27:39 +02:00
Wolfgang Kulhanek
dfdb62bea4 More details in Updates.adoc 2025-10-23 14:25:43 +02:00
Wolfgang Kulhanek
1fd8e13668 Playlist update again 2025-10-22 18:25:15 +02:00
Wolfgang Kulhanek
ba52f201b9 Another attempt to fix playlists 2025-10-22 18:15:17 +02:00
Wolfgang Kulhanek
d69b442019 Change playlist handling 2025-10-22 17:53:46 +02:00
Wolfgang Kulhanek
53021a9da1 Fix tests 2025-10-22 17:33:00 +02:00
Wolfgang Kulhanek
f8ff9f30fb Add BNB_TOKEN_CLEANUP_INTERVAL variable and re-design login page 2025-10-22 17:24:56 +02:00
Wolfgang Kulhanek
f08004a4f1 Replace json config with SQLite database 2025-10-22 16:51:40 +02:00
c122b9ac90 More formatting 2025-10-17 17:40:07 +02:00
0a7915570e Fix formatting 2025-10-17 17:38:10 +02:00
330b661a4e Fix docs 2025-10-17 17:35:25 +02:00
b777f4fd00 Setup docs 2025-10-17 17:33:04 +02:00
57c60dd462 Added Artwork 2025-10-17 15:05:27 +02:00
Wolfgang Kulhanek
87592e7fc0 Fix overeager token cleanup 2025-10-17 14:49:19 +02:00
Wolfgang Kulhanek
2ac62974c6 Change expired logs from error to debug 2025-10-17 11:42:24 +02:00
Wolfgang Kulhanek
87309fdf67 Cleanup expired tokens at startup 2025-10-17 11:33:44 +02:00
Wolfgang Kulhanek
f2fa858bd4 Token refresh logs 2025-10-17 11:24:04 +02:00
Wolfgang Kulhanek
fb1a6d9eac Fix token expiration 2025-10-17 11:14:10 +02:00
Wolfgang Kulhanek
593555bc82 Fix tests 2025-10-17 10:59:29 +02:00
Wolfgang Kulhanek
254bd5a149 More test fixes 2025-10-17 10:32:12 +02:00
Wolfgang Kulhanek
8ef6e2064d Fix tests 2025-10-17 10:28:15 +02:00
Wolfgang Kulhanek
96b27d3cdb More test errors 2025-10-17 10:22:54 +02:00
Wolfgang Kulhanek
54a3e5c1f0 Fix test error 2025-10-17 10:16:07 +02:00
Wolfgang Kulhanek
2da4530647 Fix build errors 2025-10-17 10:06:28 +02:00
Wolfgang Kulhanek
788d3e14e3 Fix test error 2025-10-17 10:02:57 +02:00
Wolfgang Kulhanek
42ecea42c2 Fix token refresh 2025-10-17 09:54:48 +02:00
Wolfgang Kulhanek
ef17fbdcff Fix playlists? 2025-10-17 09:34:22 +02:00
Wolfgang Kulhanek
665fcaf5cb Fix tests for search 2025-10-16 17:23:37 +02:00
Wolfgang Kulhanek
cafbb8f19b First attempt at fixing search 2025-10-16 17:19:33 +02:00
Wolfgang Kulhanek
4b2fb29cc1 More scrobble fixes 2025-10-16 17:05:40 +02:00
Wolfgang Kulhanek
e722aa4b7c Update gitignore 2025-10-16 17:01:50 +02:00
Wolfgang Kulhanek
ab91a6190c Update Debian to trixie 2025-10-16 15:35:55 +02:00
Wolfgang Kulhanek
892b95d0f6 Fix scrobbling. For real? 2025-10-16 15:28:47 +02:00
Wolfgang Kulhanek
d88767cbe6 Remove log.txt 2025-10-16 15:14:05 +02:00
Wolfgang Kulhanek
4965e2f8df Update scrobble logic 2025-10-16 15:13:41 +02:00
Wolfgang Kulhanek
53d06721fb Implement /report/v1 2025-10-16 14:58:11 +02:00
Wolfgang Kulhanek
55e2ea353f Implement reportPlaySeconds and reportPlayStatus 2025-10-16 14:12:28 +02:00
Wolfgang Kulhanek
c2596cb01f Ad debug info for now playing issue 2025-10-16 13:21:20 +02:00
Wolfgang Kulhanek
7da0bc627c Don't always log headers 2025-10-16 11:44:23 +02:00
Wolfgang Kulhanek
9609cbd7f0 Fix token store 2025-10-16 11:20:55 +02:00
Wolfgang Kulhanek
fee5f74a2c Save tokens 2025-10-16 10:51:40 +02:00
01f0dc942b More debug 2025-10-15 16:21:12 +02:00
cd77eda226 More debug 2025-10-15 16:18:23 +02:00
16f71e2d13 More debug statements 2025-10-15 16:11:57 +02:00
de185aa31f Add debug 2025-10-15 16:05:39 +02:00
02d6f4d01e Import missing symbol 2025-10-15 15:56:49 +02:00
17cd091325 More edits 2025-10-15 15:54:20 +02:00
7e7830f57d Change mapping 2025-10-14 19:13:36 +02:00
d6a1771768 Try non async 2025-10-14 19:04:55 +02:00
33ab815996 Mark parameters optional 2025-10-14 18:51:26 +02:00
dbc2f1f2c2 Implement dummy reportAccountAction 2025-10-14 18:47:21 +02:00
Simon
46f52b82ed Set push:true to publish image, upgrade build-push action 2025-09-22 05:09:28 +00:00
simojenki
8791430ab3 Push PR images to registries 2025-09-20 22:36:33 +07:00
chxx
419333399d update support 80.0.0 2025-09-14 23:52:37 +08: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
64 changed files with 12332 additions and 154456 deletions

View File

@@ -1,8 +1,9 @@
FROM node:16-bullseye FROM node:22-bullseye
LABEL maintainer=simojenki LABEL maintainer=simojenki
ENV JEST_TIMEOUT=60000 ENV JEST_TIMEOUT=60000
EXPOSE 4534
RUN apt-get update && \ RUN apt-get update && \
apt-get -y upgrade && \ apt-get -y upgrade && \

View File

@@ -3,11 +3,26 @@
"build": { "build": {
"dockerfile": "Dockerfile" "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", "remoteUser": "node",
"forwardPorts": [4534],
"features": { "features": {
"ghcr.io/devcontainers/features/docker-in-docker:1": { "ghcr.io/devcontainers/features/docker-in-docker:2": {
"version": "latest", "version": "latest",
"moby": true "moby": true
} }
},
"customizations": {
"vscode": {
"extensions": [
"esbenp.prettier-vscode",
"redhat.vscode-xml"
]
}
} }
} }

View File

@@ -15,54 +15,62 @@ jobs:
build_and_test: 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
- -
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@v5
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' uses: docker/login-action@v2
uses: docker/login-action@v1
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 uses: docker/login-action@v2
with:
registry: ghcr.io
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
-
name: Push image
uses: docker/build-push-action@v6
with: with:
context: . context: .
platforms: linux/amd64,linux/arm/v7,linux/arm64 platforms: linux/amd64,linux/arm/v7,linux/arm64
push: ${{ github.event_name != 'pull_request' }} push: true
tags: ${{ steps.meta.outputs.tags }} tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }} labels: ${{ steps.meta.outputs.labels }}

6
.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
@@ -9,4 +10,7 @@ node_modules
!.yarn/plugins !.yarn/plugins
!.yarn/sdks !.yarn/sdks
!.yarn/versions !.yarn/versions
.pnp.* .pnp.*
log.txt
navidrome.txt
bonob.txt

1
.npmrc Normal file
View File

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

1
.nvmrc
View File

@@ -1 +0,0 @@
16.6.2

File diff suppressed because one or more lines are too long

View File

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

187
CLAUDE.md Normal file
View File

@@ -0,0 +1,187 @@
# CLAUDE.md
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
## Project Overview
bonob is a Sonos SMAPI (Sonos Music API) implementation that bridges Subsonic API clones (like Navidrome and Gonic) with Sonos devices. It acts as a middleware service that translates between the Subsonic API and Sonos's proprietary music service protocol, allowing users to stream their personal music libraries to Sonos speakers.
## Development Commands
### Building and Running
```bash
# Build TypeScript to JavaScript
npm run build
# Development mode with auto-reload (requires environment variables)
npm run dev
# OR with auto-registration
npm run devr
# Register bonob service with Sonos devices
npm run register-dev
```
### Testing
```bash
# Run all tests
npm test
# Run tests in watch mode
npm run testw
# Set custom test timeout (default: 5000ms)
JEST_TIMEOUT=10000 npm test
```
### Environment Variables for Development
When running locally, you need to set several environment variables:
- `BNB_DEV_HOST_IP`: Your machine's IP address (so Sonos can reach bonob)
- `BNB_DEV_SONOS_DEVICE_IP`: IP address of a Sonos device for discovery
- `BNB_DEV_SUBSONIC_URL`: URL of your Subsonic API server (e.g., Navidrome)
## Architecture
### Core Components
**`src/app.ts`** - Application entry point
- Reads configuration from environment variables
- Initializes all services (Subsonic, Sonos, authentication)
- Wires together the Express server with appropriate dependencies
- Handles SIGTERM for graceful shutdown
**`src/server.ts`** - Express HTTP server
- Serves web UI for service registration and login
- Handles music streaming (`/stream/track/:id`)
- Generates icons and cover art (`/icon/...`, `/art/...`)
- Serves Sonos-specific XML files (strings, presentation map)
- Binds SOAP service for Sonos SMAPI communication
**`src/smapi.ts`** - Sonos SMAPI SOAP implementation (1200+ lines)
- Implements the Sonos Music API Protocol via SOAP/XML
- Core operations: `getMetadata`, `getMediaURI`, `search`, `getExtendedMetadata`
- Handles authentication flow with link codes and device auth tokens
- Manages token refresh and session management
- Maps music library concepts to Sonos browse hierarchy
**`src/subsonic.ts`** - Subsonic API client
- Implements `MusicService` and `MusicLibrary` interfaces
- Handles authentication with Subsonic servers using token-based auth
- Translates between Subsonic data models and bonob's domain types
- Supports custom player configurations for transcoding
- Special handling for Navidrome (bearer token authentication)
- Implements artist image fetching with optional caching
**`src/music_service.ts`** - Core domain types and interfaces
- Defines `MusicService` interface (auth and login)
- Defines `MusicLibrary` interface (browsing, search, streaming, rating, scrobbling)
- Domain types: `Artist`, `Album`, `Track`, `Playlist`, `Genre`, `Rating`, etc.
- Uses `fp-ts` for functional programming patterns (`TaskEither`, `Option`, `Either`)
**`src/sonos.ts`** - Sonos device discovery and registration
- Discovers Sonos devices on the network using SSDP/UPnP
- Registers/unregisters bonob as a music service with Sonos systems
- Supports both auto-discovery and seed-host based discovery
- Uses `@svrooij/sonos` library for device communication
**`src/smapi_auth.ts`** - Authentication token management
- Implements JWT-based SMAPI tokens (token + key pairs)
- Handles token verification and expiry
- Token refresh flow using `fp-ts` `TaskEither`
**`src/config.ts`** - Configuration management
- Reads and validates environment variables (all prefixed with `BNB_`)
- Legacy environment variable support (BONOB_ prefix)
- Type-safe configuration with defaults
### Key Abstractions
**BUrn (Bonob URN)** - Resource identifier system (`src/burn.ts`)
- Format: `{ system: string, resource: string }`
- Systems: `subsonic` (for cover art), `external` (for URLs like Spotify images)
- Used for abstracting art/image sources across different backends
**URL Builder** (`src/url_builder.ts`)
- Wraps URL manipulation with a builder pattern
- Handles context path for reverse proxy deployments
- Used throughout for generating URLs that Sonos devices can access
**Custom Players** (`src/subsonic.ts`)
- Allows mime-type specific transcoding configurations
- Maps source mime types to transcoded types
- Creates custom "client" names in Subsonic (e.g., "bonob+audio/flac")
- Example: `BNB_SUBSONIC_CUSTOM_CLIENTS="audio/flac>audio/mp3"`
### Data Flow
1. **Sonos App Request** → SOAP endpoint (`/ws/sonos`)
2. **SOAP Service** → Verifies auth token, calls `MusicLibrary` methods
3. **MusicLibrary** → Makes Subsonic API calls, transforms data
4. **SOAP Response** → Returns XML formatted for Sonos
For streaming:
1. **Sonos Device**`GET /stream/track/:id` with custom headers (bnbt, bnbk)
2. **Stream Handler** → Verifies token, calls `MusicLibrary.stream()`
3. **Subsonic Stream** → Proxies audio with proper mime-type handling
4. **Response** → Streams audio to Sonos, reports "now playing"
### Icon System (`src/icon.ts`)
- SVG-based icon generation with dynamic colors
- Supports foreground/background color customization via `BNB_ICON_FOREGROUND_COLOR` and `BNB_ICON_BACKGROUND_COLOR`
- Genre-specific icons
- Text overlay support (e.g., year icons like "1984")
- Holiday/festival decorations (auto-applied based on date)
- Legacy mode: renders to 80x80 PNG for older Sonos systems
### Authentication Flow
1. Sonos app requests link code via `getAppLink()`
2. User visits login URL with link code
3. User enters Subsonic credentials
4. bonob validates with Subsonic, generates service token
5. bonob associates link code with service token
6. Sonos polls `getDeviceAuthToken()` with link code
7. bonob returns SMAPI token (JWT) to Sonos
8. Subsequent requests use SMAPI token, which maps to service token
### Testing Philosophy
- Jest with ts-jest preset
- In-memory implementations for `LinkCodes`, `APITokens` for testing
- Mocking with `ts-mockito`
- Test helpers in `tests/` directory
- Console.log suppressed in tests (see `tests/setup.js`)
## Common Patterns
### Error Handling
- Use `fp-ts` `TaskEither<AuthFailure, T>` for async operations that can fail with auth errors
- SOAP faults for Sonos-specific errors (see SMAPI_FAULT_* constants)
- Promise-based error handling with `.catch()` for most async operations
### Type Safety
- Strict TypeScript (`strict: true`, `noImplicitAny: true`, `noUncheckedIndexedAccess: true`)
- Extensive use of discriminated unions
- Interface-based design for pluggable services
### Logging
- Winston-based logger (`src/logger.ts`)
- Log level controlled by `BNB_LOG_LEVEL`
- Request logging optional via `BNB_SERVER_LOG_REQUESTS`
### Functional Programming
- Heavy use of `fp-ts` for `Option`, `Either`, `TaskEither`
- Pipe-based composition (`pipe(data, fn1, fn2, ...)`)
- Immutable data transformations
## File Organization
- `src/` - TypeScript source code
- `tests/` - Jest test files (mirrors src/ structure)
- `build/` - Compiled JavaScript (gitignored)
- `web/` - HTML templates (Eta templating) and static assets
- `typings/` - Custom TypeScript definitions
## Important Constraints
- bonob must be accessible from Sonos devices at `BNB_URL`
- `BNB_URL` cannot contain "localhost" (validation error)
- Sonos requires specific XML formats (SMAPI WSDL v1.19.6)
- Streaming must handle HTTP range requests for seek functionality
- Token lifetime (`BNB_AUTH_TIMEOUT`) should be less than Subsonic session timeout

91
DOCUMENTATION.md Normal file
View File

@@ -0,0 +1,91 @@
# Bonob Source Code Documentation
This document provides an overview of the source files in the `src` directory, explaining the purpose and functionality of each.
### `api_tokens.ts`
Manages API tokens for authentication. It includes an in-memory implementation for storing and retrieving tokens, using SHA256 to mint new tokens.
### `app.ts`
This is the main entry point of the application. It initializes the server, configures the music service (Subsonic), and sets up the integration with Sonos. It reads the application config, sets up the Subsonic connection, and starts the Express server.
### `b64.ts`
Provides simple utility functions for Base64 encoding and decoding of strings.
### `burn.ts`
Handles the creation and parsing of "Bonob URNs" (BURNs), which are unique resource identifiers used within the system. It supports encryption and shorthand notations for more compact URNs.
### `clock.ts`
Provides an abstraction for time-related functions, which is useful for testing. It includes a `SystemClock` that uses the actual system time and a `FixedClock` for tests. It also contains logic for detecting special dates like Christmas and Halloween for seasonal features.
### `config.ts`
Manages the application's configuration by reading environment variables. It defines settings for the server, Sonos integration, Subsonic connection, and other features like scrobbling.
### `encryption.ts`
Implements encryption and decryption functionality using JSON Web Signatures (JWS). It provides a simple interface for encrypting and decrypting strings.
### `i8n.ts`
Handles internationalization (i18n) by providing translations for different languages supported by the Sonos app. It includes translations for UI elements and messages.
### `icon.ts`
Manages SVG icons used in the Sonos app. It allows for transformations like changing colors and applying special styles for festivals and holidays.
### `link_codes.ts`
Implements a system for linking Sonos devices with user accounts. It generates temporary codes that users can use to log in and associate their accounts.
### `logger.ts`
Configures the application-wide logger using Winston. It sets up logging levels and formats.
### `music_service.ts`
Defines the interfaces for a generic music service. This includes methods for authentication, browsing content (artists, albums, tracks), streaming audio, and managing playlists.
### `register.ts`
A command-line script used to register the Bonob service with Sonos devices on the local network.
### `registrar.ts`
Contains the core logic for registering the Bonob service with Sonos devices. It fetches service details from the Bonob server and sends the registration request to a Sonos device.
### `server.ts`
Sets up the Express web server. It defines the routes for the web interface, the Sonos Music API (SMAPI) endpoints, and audio streaming. It also handles user authentication and session management.
### `smapi_auth.ts`
Handles authentication for the Sonos Music API (SMAPI). It is responsible for issuing and verifying JWTs (JSON Web Tokens) that secure the communication between Sonos devices and the Bonob server.
### `smapi_token_store.ts`
Provides an interface and two implementations (in-memory and file-based) for storing SMAPI authentication tokens. This allows the server to persist user sessions.
### `smapi.ts`
Implements the Sonos Music API (SMAPI) using SOAP. This file is responsible for handling all the requests from Sonos devices, such as browsing music, searching, and getting track metadata.
### `sonos.ts`
Manages interactions with Sonos devices on the local network. This includes device discovery and service registration.
### `subsonic.ts`
Implements the `MusicService` interface for Subsonic-compatible media servers (like Navidrome). It handles all communication with the Subsonic API to fetch music data and stream audio.
### `url_builder.ts`
A utility class for building and manipulating URLs in a structured way.
### `utils.ts`
Contains miscellaneous utility functions used throughout the application, such as a function for tidying up XML strings.

View File

@@ -1,4 +1,4 @@
FROM node:16-bullseye-slim as build FROM node:22-trixie-slim AS build
WORKDIR /bonob WORKDIR /bonob
@@ -9,12 +9,11 @@ COPY typings ./typings
COPY web ./web COPY web ./web
COPY tests ./tests COPY tests ./tests
COPY jest.config.js . COPY jest.config.js .
COPY package.json .
COPY register.js . COPY register.js .
COPY .npmrc .
COPY tsconfig.json . COPY tsconfig.json .
COPY yarn.lock . COPY package.json .
COPY .yarnrc.yml . COPY package-lock.json .
COPY .yarn/releases ./.yarn/releases
ENV JEST_TIMEOUT=60000 ENV JEST_TIMEOUT=60000
ENV DEBIAN_FRONTEND=noninteractive ENV DEBIAN_FRONTEND=noninteractive
@@ -29,26 +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 config set network-timeout 600000 -g && \ npm install && \
yarn install \ npm test && \
--prefer-offline \ npm run gitinfo && \
--frozen-lockfile \ npm run build && \
--non-interactive \
--production=false && \
yarn test --no-cache && \
yarn gitinfo && \
yarn build && \
rm -Rf node_modules && \ rm -Rf node_modules && \
NODE_ENV=production yarn install \ NODE_ENV=production npm install --omit=dev
--prefer-offline \
--pure-lockfile \
--non-interactive \
--production=true
FROM node:16-bullseye-slim FROM node:22-trixie-slim
LABEL maintainer=simojenki 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
@@ -59,19 +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 \ apt-get -y install --no-install-recommends \
libvips \ libvips \
tzdata && \ 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, da-DK & nl-NL supported currently, require translations for other languages). [Sonos localization and supported languages](https://developer.sonos.com/build/content-service-add-features/strings-and-localization/) - Localization (only en-US, da-DK, nl-NL & 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
@@ -146,13 +163,15 @@ 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 that are sourced externally. ie. Navidrome provides spotify URLs. Remember to provide a volume-mapping for Docker, when enabling this cache. BNB_SUBSONIC_ARTIST_IMAGE_CACHE | undefined | Path for caching of artist images that are sourced externally. ie. Navidrome provides spotify URLs. Remember to provide a volume-mapping for Docker, when enabling this cache.
BNB_SCROBBLE_TRACKS | true | Whether to scrobble the playing of a track if it has been played for >30s BNB_SCROBBLE_TRACKS | true | Whether to scrobble the playing of a track if it has been played for >30s
BNB_REPORT_NOW_PLAYING | true | Whether to report a track as now playing BNB_REPORT_NOW_PLAYING | true | Whether to report a track as now playing
@@ -199,19 +218,22 @@ Afterwards the Sonos app displays a dropdown underneath the service, allowing to
- Implement the MusicService/MusicLibrary interface - Implement the MusicService/MusicLibrary interface
- Startup bonob with your new implementation. - Startup bonob with your new implementation.
## A note on transcoding ## Transcoding
tldr; Transcoding to mp3/m4a is not supported as sonos devices will not play the track. However transcoding to flac does work, use BNB_SUBSONIC_CUSTOM_CLIENTS=audio/flac if you want to transcode flac->flac ie. to downsample HD flacs (see below). ### Transcode everything
Sonos devices are very particular about how audio streams are presented to them, see [streaming basics](https://developer.sonos.com/build/content-service-add-features/streaming-basics/). When using transcoding both Navidrome and Gonic report no 'content-length', nor do they support range queries, this will cause the sonos device to fail to play the track. The simplest transcoding solution is to simply change the player ('bonob') in your subsonic server to transcode all content to something sonos supports (ie. mp3 & flac)
### Audio File type specific transcoding options within Subsonic ### Audio file type specific transcoding
In some situations you may wish to have different 'Players' within you Subsonic server so that you can configure different transcoding options depending on the file type. For example if you have flacs with a mixture of frequency formats where not all are supported by sonos [See issue #52](https://github.com/simojenki/bonob/issues/52) & [Sonos supported audio formats](https://developer.sonos.com/build/content-service-add-features/supported-audio-formats/) Disclaimer: The following configuration is more complicated, and if you get the configuration wrong sonos will refuse to play your content.
In some situations you may wish to have different 'Players' within your Subsonic server so that you can configure different transcoding options depending on the file type. For example if you have flacs with a mixture of frequency formats where not all are supported by sonos [See issue #52](https://github.com/simojenki/bonob/issues/52) & [Sonos supported audio formats](https://docs.sonos.com/docs/supported-audio-formats)
In this case you could set; In this case you could set;
```bash ```bash
# This is equivalent to setting BNB_SUBSONIC_CUSTOM_CLIENTS="audio/flac>audio/flac"
BNB_SUBSONIC_CUSTOM_CLIENTS="audio/flac" BNB_SUBSONIC_CUSTOM_CLIENTS="audio/flac"
``` ```
@@ -227,7 +249,16 @@ ffmpeg -i %s -af aformat=sample_fmts=s16|s32:sample_rates=8000|11025|16000|22050
ffmpeg -i %s -af aformat=sample_fmts=s16:sample_rates=8000|11025|16000|22050|24000|32000|44100|48000 -f flac - ffmpeg -i %s -af aformat=sample_fmts=s16:sample_rates=8000|11025|16000|22050|24000|32000|44100|48000 -f flac -
``` ```
### Changing Icon colors Alternatively perhaps you have some aac (audio/mpeg) files that will not play in sonos (ie. voice recordings from an iPhone), however you do not want to transcode all everything, just those audio/mpeg files. Let's say you want to transcode them to mp3s, you could set the following;
```bash
BNB_SUBSONIC_CUSTOM_CLIENTS="audio/mpeg>audio/mp3"
```
And then configure the 'bonob+audio/mpeg' player in your subsonic server.
## Changing Icon colors
```bash ```bash
-e BNB_ICON_FOREGROUND_COLOR=white \ -e BNB_ICON_FOREGROUND_COLOR=white \
@@ -257,6 +288,7 @@ ffmpeg -i %s -af aformat=sample_fmts=s16:sample_rates=8000|11025|16000|22050|240
![Spotify-ish](https://github.com/simojenki/bonob/blob/master/docs/images/spotify-ish.png?raw=true) ![Spotify-ish](https://github.com/simojenki/bonob/blob/master/docs/images/spotify-ish.png?raw=true)
## Credits ## Credits
- Icons courtesy of: [Navidrome](https://www.navidrome.org/), [Vectornator](https://www.vectornator.io/icons), and @jicho - Icons courtesy of: [Navidrome](https://www.navidrome.org/), [Vectornator](https://www.vectornator.io/icons), and @jicho

68
UPDATES.adoc Normal file
View File

@@ -0,0 +1,68 @@
= Updates for SMAPI
Run Bonob on your server.
== Updates made to original code
* Proper Token handling after login. Also handling of periodic token refresh.
* Store Tokens in an SQLite database (in mounted `/config` directory).
* Added variable `BNB_TOKEN_CLEANUP_INTERVAL` with a default of `60` (minutes) to set how often expired tokens should be cleaned up out of the database.
* Multi-account logins. Register one Bonob and log in with multiple Navidrome users for easy account switching in the Sonos app.
* Global Search integration (Artist, Album, Track)
* Scrobbling support to Navidrome. After one song has been completely played the album will show up in the "Recently played" section.
* Playlist support. It shows both public and private (for the current account) playlists.
* Modernized Login page.
== To be done
* Remove all now unnecessary logic:
** Handling of `BNB_SONOS_SEED_HOST`
** Autoregistration with Sonos devices (`BNB_SONOS_AUTO_REGISTER`)
** Handling of `BNB_SONOS_DEVICE_DISCOVERY`
* Implement Thumbs Up/Down or Star ratings (this is probably a Sonos Service configuration thing - with maybe some code changes).
* Implement Playlist editing
== Running Bonob
Bonob now needs a volume to store the token database. In the example below that directory is `/var/containers/bonob`. Adapt as needed.
Also the example below uses a `bonob` user on the system with ID `1210` and group `100`. The database directory should be owned by that user.
.Example systemd file (`/usr/lib/systemd/system/bonob.service`)
[source]
----
[Unit]
Description=Bonob container service
Wants=network.target
After=network-online.target
[Service]
Environment=PODMAN_SYSTEMD_UNIT=%n
Restart=always
ExecStartPre=-/usr/bin/podman rm -f bonob
ExecStart=/usr/bin/podman run --rm \
--name bonob \
--label "io.containers.autoupdate=image" \
--user 1210:100 \
--env BNB_SONOS_SERVICE_NAME="Navidrome" \
--env BNB_PORT=8200 \
--env BNB_URL="https://bonob.mydomain.com" \
--env BNB_SECRET="Some random string" \
--env BNB_SONOS_SERVICE_ID=Your Sonos ID \
--env BNB_SUBSONIC_URL=https://music.mydomain.com \
--env BNB_ICON_FOREGROUND_COLOR="black" \
--env BNB_ICON_BACKGROUND_COLOR="#65d7f4" \
--env BNB_SONOS_AUTO_REGISTER=false \
--env BNB_SONOS_DEVICE_DISCOVERY=false \
--env BNB_LOG_LEVEL="info" \
--env TZ="Europe/Vienna" \
--volume /var/containers/bonob:/config:Z \
--publish 8200:8200 \
quay.io/wkulhanek/bonob:latest
ExecStop=/usr/bin/podman rm -f bonob
StandardOutput=syslog
StandardError=syslog
SyslogIdentifier=bonob
[Install]
WantedBy=multi-user.target default.target
----

7831
package-lock.json generated Normal file

File diff suppressed because it is too large Load Diff

View File

@@ -6,67 +6,72 @@
"author": "simojenki <simojenki@users.noreply.github.com>", "author": "simojenki <simojenki@users.noreply.github.com>",
"license": "GPL-3.0-only", "license": "GPL-3.0-only",
"dependencies": { "dependencies": {
"@svrooij/sonos": "^2.5.0", "@svrooij/sonos": "^2.6.0-beta.11",
"@types/express": "^4.17.17", "@types/express": "^4.17.21",
"@types/fs-extra": "^11.0.1", "@types/fs-extra": "^11.0.4",
"@types/jsonwebtoken": "^9.0.1", "@types/jsonwebtoken": "^9.0.7",
"@types/jws": "^3.2.5", "@types/jws": "^3.2.10",
"@types/morgan": "^1.9.4", "@types/morgan": "^1.9.9",
"@types/node": "^16.11.7", "@types/node": "^20.11.5",
"@types/randomstring": "^1.1.8", "@types/randomstring": "^1.3.0",
"@types/sharp": "^0.31.1", "@types/underscore": "^1.13.0",
"@types/underscore": "^1.11.4", "@types/uuid": "^10.0.0",
"@types/uuid": "^9.0.1", "@types/xmldom": "^0.1.34",
"@types/xmldom": "0.1.31", "@xmldom/xmldom": "^0.9.7",
"axios": "^1.3.4", "axios": "^1.7.8",
"dayjs": "^1.11.7", "better-sqlite3": "^12.4.1",
"eta": "^2.0.1", "dayjs": "^1.11.13",
"express": "^4.18.2", "eta": "^2.2.0",
"fp-ts": "^2.13.1", "express": "^4.18.3",
"fs-extra": "^11.1.0", "fp-ts": "^2.16.9",
"jsonwebtoken": "^9.0.0", "fs-extra": "^11.2.0",
"jsonwebtoken": "^9.0.2",
"jws": "^4.0.0", "jws": "^4.0.0",
"libxmljs2": "^0.31.0",
"morgan": "^1.10.0", "morgan": "^1.10.0",
"node-html-parser": "^6.1.5", "node-html-parser": "^6.1.13",
"randomstring": "^1.2.3", "randomstring": "^1.3.0",
"sharp": "^0.31.3", "sharp": "^0.33.5",
"soap": "^1.0.0", "soap": "^1.1.6",
"ts-md5": "^1.3.1", "ts-md5": "^1.3.1",
"typescript": "^4.9.5", "typescript": "^5.7.2",
"underscore": "^1.13.6", "underscore": "^1.13.7",
"urn-lib": "^2.0.0", "urn-lib": "^2.0.0",
"uuid": "^9.0.0", "uuid": "^11.0.3",
"winston": "^3.8.2", "winston": "^3.17.0",
"xmldom-ts": "^0.3.1" "xmldom-ts": "^0.3.1",
"xpath": "^0.0.34"
}, },
"devDependencies": { "devDependencies": {
"@types/chai": "^4.3.4", "@types/better-sqlite3": "^7.6.13",
"@types/jest": "^29.4.0", "@types/chai": "^5.0.1",
"@types/mocha": "^10.0.1", "@types/jest": "^29.5.14",
"@types/supertest": "^2.0.12", "@types/mocha": "^10.0.10",
"@types/tmp": "^0.2.3", "@types/supertest": "^6.0.2",
"chai": "^4.3.7", "@types/tmp": "^0.2.6",
"get-port": "^6.1.2", "chai": "^5.1.2",
"image-js": "^0.35.3", "get-port": "^7.1.0",
"jest": "^29.4.3", "image-js": "^0.35.6",
"nodemon": "^2.0.21", "jest": "^29.7.0",
"supertest": "^6.3.3", "nodemon": "^3.1.7",
"tmp": "^0.2.1", "supertest": "^7.0.0",
"ts-jest": "^29.0.5", "tmp": "^0.2.3",
"ts-jest": "^29.2.5",
"ts-mockito": "^2.6.1", "ts-mockito": "^2.6.1",
"ts-node": "^10.9.1", "ts-node": "^10.9.2",
"xmldom-ts": "^0.3.1",
"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"
}, }
"packageManager": "yarn@1.22.19"
} }

View File

@@ -0,0 +1,85 @@
= Setting up Sonos Service
== Prerequisites
* In your Sonos App get your Sonos ID (About my Sonos System)
+
image::images/about.png[]
* Navidrome running and available from the Internet. E.g. via https://music.mydomain.com
* Bonob running and available from the Internet. E.g. via https://bonob.mydomain.com
You can use any method to make these URLs available. Cloudflare Tunnels, Pangolin, reverse proxy, etc.
== Sonos Service Integration
* Log into https://play.sonos.com
* Once logged in go to https://developer.sonos.com/s/integrations
* Create a *New Content Integration*
** General Information
*** Service Name: Navidrome
*** Service Availability: Global
*** Checkbox checked
*** Website/Social Media URLs: https://music.mydomain.com (Some URL - e.g. your Navidrome server)
** Sonos Music API
*** Integration ID: com.mydomain.music (your domain in reverse)
*** Configuration Label: 1.0
*** SMAPI Endpoint: https://bonob.mydomain.com/ws/sonos
*** SMAPI Endpoint Version: 1.1
*** Radio Endpoint: empty
*** Reporting Endpoint: https://bonob.mydomain.com/report/v1
*** Reporting Endpoint Version: 2.3
*** Authentication Method: OAuth
*** Redirect: https://bonob.mydomain.com/login
*** Auth Token Time To Life: Empty
*** Browse/Search Results Page Size: 100
*** Polling Interval: 60
** Brand Assets
*** Just upload the various assets from the `sonos_artwork` directory.
** Localization Resources
*** Write something about your service in the various fields (except Explicit Filter Description).
** Integration Capabilities
*** Check the first two (*Enable Extended Metadata* and *Enable Extended Metadata for Playlists*) and nothing else.
** Image Replacement Rules
*** No changes
** Browse Options
*** No changes
** Search Capabilities
*** API Catalog Type: SMAPI Catalog
*** Catalog Title: Music
*** Catalog Type: GLOBAL
*** Add Three Categories with ID and Mapped ID:
+
Albums - albums
Artists - artists
Tracks - tracks
** Content Actions
*** No changes
** Service Deployment Settings
*** Sonos ID: Your Sonos ID (from About my system). This is how only your controller sees the new service.
*** System Name: Whatever you want
** Service Configuration
*** Click on *Refresh* and then *Send*. You should get a success message that you can dismiss with *Done*.
* In your app search for your service name and add Service in your app as usual.

Binary file not shown.

After

Width:  |  Height:  |  Size: 37 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 73 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 10 KiB

View File

@@ -0,0 +1,18 @@
<svg xmlns="http://www.w3.org/2000/svg" width="800" height="200" viewBox="0 0 800 200" role="img" aria-labelledby="title desc">
<title id="title">Bonob Subsonic Logo</title>
<desc id="desc">A blue music-note icon with family dots on the left, followed by stacked text Bonob Navidrome in blue.</desc>
<!-- Icon (scaled and positioned) -->
<g transform="translate(20,20) scale(4)">
<rect x="0" y="0" width="40" height="40" rx="6" ry="6" fill="#1976d2"/>
<circle cx="11.5" cy="15.5" r="1.6" fill="#ffffff"/>
<circle cx="11.5" cy="22.5" r="1.6" fill="#ffffff"/>
<circle cx="22" cy="26" r="4" fill="#ffffff"/>
<rect x="24" y="10" width="1.6" height="16" rx="0.8" fill="#ffffff"/>
<path d="M25.6 11.2 C29.0 10.6 30.2 13.6 27.4 14.6 C29.2 15.4 27.6 16.6 25.6 15.8 Z" fill="#ffffff"/>
</g>
<!-- Text stacked in two lines -->
<text x="240" y="90" font-family="Arial, Helvetica, sans-serif" font-size="80" fill="#1976d2">Bonob</text>
<text x="240" y="160" font-family="Arial, Helvetica, sans-serif" font-size="80" fill="#1976d2">Navidrome</text>
</svg>

After

Width:  |  Height:  |  Size: 1.1 KiB

View File

@@ -0,0 +1,19 @@
<svg xmlns="http://www.w3.org/2000/svg" width="180" height="20" viewBox="0 0 180 20" role="img" aria-labelledby="title desc">
<title id="title">Bonob Subsonic Logo</title>
<desc id="desc">A blue music-note icon with family dots, followed by the text Bonob Subsonic in blue.</desc>
<!-- Icon scaled down to fit height -->
<g transform="scale(0.45) translate(0,0)">
<rect x="0" y="0" width="40" height="40" rx="6" ry="6" fill="#1976d2"/>
<circle cx="11.5" cy="15.5" r="1.6" fill="#ffffff"/>
<circle cx="11.5" cy="22.5" r="1.6" fill="#ffffff"/>
<circle cx="22" cy="26" r="4" fill="#ffffff"/>
<rect x="24" y="10" width="1.6" height="16" rx="0.8" fill="#ffffff"/>
<path d="M25.6 11.2 C29.0 10.6 30.2 13.6 27.4 14.6 C29.2 15.4 27.6 16.6 25.6 15.8 Z" fill="#ffffff"/>
</g>
<!-- Text -->
<text x="28" y="15" font-family="Arial, Helvetica, sans-serif" font-size="12" fill="#1976d2">
Bonob Subsonic
</text>
</svg>

After

Width:  |  Height:  |  Size: 950 B

View File

@@ -0,0 +1,20 @@
<svg xmlns="http://www.w3.org/2000/svg" width="40" height="40" viewBox="0 0 40 40" role="img" aria-labelledby="title desc">
<title id="title">Bonob Navidrome Music Server</title>
<desc id="desc">Blue rounded square with a white music note and two small circles representing family.</desc>
<!-- Blue rounded background -->
<rect x="0" y="0" width="40" height="40" rx="6" ry="6" fill="#1976d2"/>
<!-- Family dots (simple, symbolic) -->
<circle cx="11.5" cy="15.5" r="1.6" fill="#ffffff"/>
<circle cx="11.5" cy="22.5" r="1.6" fill="#ffffff"/>
<!-- Note head -->
<circle cx="22" cy="26" r="4" fill="#ffffff"/>
<!-- Note stem -->
<rect x="24" y="10" width="1.6" height="16" rx="0.8" fill="#ffffff"/>
<!-- Note flag (simple, filled shape) -->
<path d="M25.6 11.2 C29.0 10.6 30.2 13.6 27.4 14.6 C29.2 15.4 27.6 16.6 25.6 15.8 Z" fill="#ffffff"/>
</svg>

After

Width:  |  Height:  |  Size: 877 B

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:element name="contentKey" type="tns:encryptionContext" minOccurs="0" maxOccurs="1"/> <xs:choice minOccurs="0">
<xs:element name="contentKey" type="tns:encryptionContext" minOccurs="0" maxOccurs="1"/>
<xs:element name="contentKeys" type="tns:contentKeys" minOccurs="0" maxOccurs="1"/>
</xs:choice>
<xs:element name="httpHeaders" type="tns:httpHeaders" minOccurs="0" maxOccurs="1"/> <xs:element name="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,11 +4,12 @@ import server from "./server";
import logger from "./logger"; import logger from "./logger";
import { import {
appendMimeTypeToClientFor,
axiosImageFetcher, axiosImageFetcher,
cachingImageFetcher, cachingImageFetcher,
DEFAULT, SubsonicMusicService,
Subsonic, TranscodingCustomPlayers,
NO_CUSTOM_PLAYERS,
Subsonic
} from "./subsonic"; } from "./subsonic";
import { InMemoryAPITokens, sha256 } from "./api_tokens"; import { InMemoryAPITokens, sha256 } from "./api_tokens";
import { InMemoryLinkCodes } from "./link_codes"; import { InMemoryLinkCodes } from "./link_codes";
@@ -17,6 +18,7 @@ import sonos, { bonobService } from "./sonos";
import { MusicService } from "./music_service"; import { MusicService } from "./music_service";
import { SystemClock } from "./clock"; import { SystemClock } from "./clock";
import { JWTSmapiLoginTokens } from "./smapi_auth"; import { JWTSmapiLoginTokens } from "./smapi_auth";
import { SQLiteSmapiTokenStore } from "./smapi_token_store";
const config = readConfig(); const config = readConfig();
const clock = SystemClock; const clock = SystemClock;
@@ -32,18 +34,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(
config.subsonic.url, new Subsonic(
streamUserAgent, config.subsonic.url,
artistImageFetcher customPlayers,
artistImageFetcher
),
customPlayers
); );
const featureFlagAwareMusicService: MusicService = { const featureFlagAwareMusicService: MusicService = {
@@ -77,6 +82,16 @@ const version = fs.existsSync(GIT_INFO)
? fs.readFileSync(GIT_INFO).toString().trim() ? fs.readFileSync(GIT_INFO).toString().trim()
: "v??"; : "v??";
// Initialize SQLite token store
const smapiTokenStore = new SQLiteSmapiTokenStore(config.tokenStore.dbPath);
// Migrate existing JSON tokens if they exist
const legacyJsonPath = "/config/tokens.json";
if (fs.existsSync(legacyJsonPath)) {
logger.info(`Found legacy JSON token file at ${legacyJsonPath}, attempting migration...`);
smapiTokenStore.migrateFromJSON(legacyJsonPath);
}
const app = server( const app = server(
sonosSystem, sonosSystem,
bonob, bonob,
@@ -88,10 +103,12 @@ 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,
smapiTokenStore,
tokenCleanupIntervalMinutes: config.tokenStore.cleanupIntervalMinutes
} }
); );
@@ -120,6 +137,7 @@ process.on('SIGTERM', () => {
expressServer.close(() => { expressServer.close(() => {
logger.info('HTTP server closed'); logger.info('HTTP server closed');
}); });
smapiTokenStore.close();
process.exit(0); process.exit(0);
}); });

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

@@ -85,6 +85,7 @@ export default function () {
validationPattern: COLOR, validationPattern: COLOR,
}), }),
}, },
logRequests: bnbEnvVar<boolean>("SERVER_LOG_REQUESTS", { default: false, parser: asBoolean }),
sonos: { sonos: {
serviceName: bnbEnvVar<string>("SONOS_SERVICE_NAME", { default: "bonob" })!, serviceName: bnbEnvVar<string>("SONOS_SERVICE_NAME", { default: "bonob" })!,
discovery: { discovery: {
@@ -97,12 +98,16 @@ export default function () {
sid: bnbEnvVar<number>("SONOS_SERVICE_ID", { default: 246, parser: asInt }), sid: bnbEnvVar<number>("SONOS_SERVICE_ID", { default: 246, parser: asInt }),
}, },
subsonic: { subsonic: {
url: bnbEnvVar("SUBSONIC_URL", { legacy: ["BONOB_NAVIDROME_URL"], default: `http://${hostname()}:4533` })!, url: url(bnbEnvVar("SUBSONIC_URL", { legacy: ["BONOB_NAVIDROME_URL"], default: `http://${hostname()}:4533` })!),
customClientsFor: bnbEnvVar<string>("SUBSONIC_CUSTOM_CLIENTS", { legacy: ["BONOB_NAVIDROME_CUSTOM_CLIENTS"] }), customClientsFor: bnbEnvVar<string>("SUBSONIC_CUSTOM_CLIENTS", { legacy: ["BONOB_NAVIDROME_CUSTOM_CLIENTS"] }),
artistImageCache: bnbEnvVar<string>("SUBSONIC_ARTIST_IMAGE_CACHE"), artistImageCache: bnbEnvVar<string>("SUBSONIC_ARTIST_IMAGE_CACHE"),
}, },
scrobbleTracks: bnbEnvVar<boolean>("SCROBBLE_TRACKS", { default: true, parser: asBoolean }), scrobbleTracks: bnbEnvVar<boolean>("SCROBBLE_TRACKS", { default: true, parser: asBoolean }),
reportNowPlaying: reportNowPlaying:
bnbEnvVar<boolean>("REPORT_NOW_PLAYING", { default: true, parser: asBoolean }), bnbEnvVar<boolean>("REPORT_NOW_PLAYING", { default: true, parser: asBoolean }),
tokenStore: {
dbPath: bnbEnvVar<string>("TOKEN_DB_PATH", { default: "/config/tokens.db" })!,
cleanupIntervalMinutes: bnbEnvVar<number>("TOKEN_CLEANUP_INTERVAL", { default: 60, parser: asInt })!,
},
}; };
} }

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 => ({
ALGORITHM, hash: it,
key, decipher: createDecipheriv(
Buffer.from(parts[0]!, "hex") ALGORITHM,
); key,
return Buffer.concat([ Buffer.from(it.iv, "hex")
decipher.update(Buffer.from(parts[1]!, "hex")), )
decipher.final(), })),
]).toString(); E.map(it => Buffer.concat([
}, it.decipher.update(Buffer.from(it.hash.data, "hex")),
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" | "da-DK" | "nl-NL"; export type SUPPORTED_LANG = "en-US" | "da-DK" | "fr-FR" | "nl-NL";
export type KEY = export type KEY =
| "AppLinkMessage" | "AppLinkMessage"
| "artists" | "artists"
| "albums" | "albums"
| "internetRadio"
| "playlists" | "playlists"
| "genres" | "genres"
| "random" | "random"
@@ -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",
@@ -92,6 +96,7 @@ const translations: Record<SUPPORTED_LANG, Record<KEY, string>> = {
AppLinkMessage: "Forbinder Sonos med $BNB_SONOS_SERVICE_NAME", AppLinkMessage: "Forbinder Sonos med $BNB_SONOS_SERVICE_NAME",
artists: "Kunstnere", artists: "Kunstnere",
albums: "Album", albums: "Album",
internetRadio: "Internet Radio",
tracks: "Numre", tracks: "Numre",
playlists: "Afspilningslister", playlists: "Afspilningslister",
genres: "Genre", genres: "Genre",
@@ -122,6 +127,7 @@ const translations: Record<SUPPORTED_LANG, Record<KEY, string>> = {
loginFailed: "Log på fejlede!", loginFailed: "Log på fejlede!",
noSonosDevices: "Ingen Sonos enheder", noSonosDevices: "Ingen Sonos enheder",
favourites: "Favoritter", favourites: "Favoritter",
years: "Flere år",
STAR: "Tilføj stjerne", STAR: "Tilføj stjerne",
UNSTAR: "Fjern stjerne", UNSTAR: "Fjern stjerne",
STAR_SUCCESS: "Stjerne tilføjet", STAR_SUCCESS: "Stjerne tilføjet",
@@ -129,10 +135,54 @@ const translations: Record<SUPPORTED_LANG, Record<KEY, string>> = {
LOVE: "Synes godt om", LOVE: "Synes godt om",
LOVE_SUCCESS: "Syntes godt om" LOVE_SUCCESS: "Syntes godt om"
}, },
"fr-FR": {
AppLinkMessage: "Associer Sonos à $BNB_SONOS_SERVICE_NAME",
artists: "Artistes",
albums: "Albums",
internetRadio: "Radio Internet",
tracks: "Pistes",
playlists: "Playlists",
genres: "Genres",
random: "Aléatoire",
topRated: "Les mieux notés",
recentlyAdded: "Récemment ajouté",
recentlyPlayed: "Récemment joué",
mostPlayed: "Les plus joué",
success: "Succès",
failure: "Échec",
expectedConfig: "Configuration attendue",
existingServiceConfig: "La configuration de service existe",
noExistingServiceRegistration: "Aucun enregistrement de service existant",
register: "Inscription",
removeRegistration: "Supprimer l'inscription",
devices: "Appareils",
services: "Services",
login: "Se connecter",
logInToBonob: "Se connecter à $BNB_SONOS_SERVICE_NAME",
username: "Nom d'utilisateur",
password: "Mot de passe",
successfullyRegistered: "Connecté avec succès",
registrationFailed: "Échec de la connexion !",
successfullyRemovedRegistration: "Inscription supprimée avec succès",
failedToRemoveRegistration: "Échec de la suppression de l'inscription !",
invalidLinkCode: "Code non valide !",
loginSuccessful: "Connexion réussie !",
loginFailed: "La connexion a échoué !",
noSonosDevices: "Aucun appareil Sonos",
favourites: "Favoris",
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",
@@ -163,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

@@ -46,15 +46,24 @@ export type Genre = {
id: string; id: string;
} }
export type Year = {
year: string;
}
export type Rating = { export type Rating = {
love: boolean; love: boolean;
stars: number; stars: number;
} }
export type Encoding = {
player: string,
mimeType: string
}
export type Track = { export type Track = {
id: string; id: string;
name: string; name: string;
mimeType: string; encoding: Encoding,
duration: number; duration: number;
number: number | undefined; number: number | undefined;
genre: Genre | undefined; genre: Genre | undefined;
@@ -64,6 +73,13 @@ export type Track = {
rating: Rating; rating: Rating;
}; };
export type RadioStation = {
id: string,
name: string,
url: string,
homePage?: string
}
export type Paging = { export type Paging = {
_index: number; _index: number;
_count: number; _count: number;
@@ -88,11 +104,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 => ({
@@ -113,7 +131,8 @@ export const albumToAlbumSummary = (it: Album): AlbumSummary => ({
export const playlistToPlaylistSummary = (it: Playlist): PlaylistSummary => ({ export const playlistToPlaylistSummary = (it: Playlist): PlaylistSummary => ({
id: it.id, id: it.id,
name: it.name name: it.name,
coverArt: it.coverArt
}) })
export type StreamingHeader = "content-type" | "content-length" | "content-range" | "accept-ranges"; export type StreamingHeader = "content-type" | "content-length" | "content-range" | "accept-ranges";
@@ -131,7 +150,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 & {
@@ -159,6 +179,7 @@ export interface MusicLibrary {
tracks(albumId: string): Promise<Track[]>; 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,
@@ -181,4 +202,6 @@ export interface MusicLibrary {
removeFromPlaylist(playlistId: string, indicies: number[]): Promise<boolean> removeFromPlaylist(playlistId: string, indicies: number[]): Promise<boolean>
similarSongs(id: string): Promise<Track[]>; similarSongs(id: string): Promise<Track[]>;
topSongs(artistId: string): Promise<Track[]>; topSongs(artistId: string): Promise<Track[]>;
radioStation(id: string): Promise<RadioStation>
radioStations(): Promise<RadioStation[]>
} }

View File

@@ -31,18 +31,37 @@ 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 {
JWTSmapiLoginTokens, JWTSmapiLoginTokens,
SmapiAuthTokens, SmapiAuthTokens,
} from "./smapi_auth"; } from "./smapi_auth";
import { SmapiTokenStore, InMemorySmapiTokenStore } from "./smapi_token_store";
export const BONOB_ACCESS_TOKEN_HEADER = "bat"; export const BONOB_ACCESS_TOKEN_HEADER = "bat";
// Session storage for tracking active streams (for scrobbling)
type StreamSession = {
serviceToken: string;
trackId: string;
timestamp: number;
};
const streamSessions = new Map<string, StreamSession>();
// Clean up old sessions (older than 1 hour)
setInterval(() => {
const oneHourAgo = Date.now() - (60 * 60 * 1000);
for (const [sid, session] of streamSessions.entries()) {
if (session.timestamp < oneHourAgo) {
streamSessions.delete(sid);
}
}
}, 5 * 60 * 1000).unref(); // Run every 5 minutes, but don't prevent process exit
interface RangeFilter extends Transform { interface RangeFilter extends Transform {
range: (length: number) => string; range: (length: number) => string;
} }
@@ -93,6 +112,8 @@ export type ServerOpts = {
version: string; version: string;
smapiAuthTokens: SmapiAuthTokens; smapiAuthTokens: SmapiAuthTokens;
externalImageResolver: ImageFetcher; externalImageResolver: ImageFetcher;
smapiTokenStore: SmapiTokenStore;
tokenCleanupIntervalMinutes: number;
}; };
const DEFAULT_SERVER_OPTS: ServerOpts = { const DEFAULT_SERVER_OPTS: ServerOpts = {
@@ -109,6 +130,8 @@ const DEFAULT_SERVER_OPTS: ServerOpts = {
"1m" "1m"
), ),
externalImageResolver: axiosImageFetcher, externalImageResolver: axiosImageFetcher,
smapiTokenStore: new InMemorySmapiTokenStore(),
tokenCleanupIntervalMinutes: 60,
}; };
function server( function server(
@@ -134,6 +157,7 @@ function server(
app.use(morgan("combined")); app.use(morgan("combined"));
} }
app.use(express.urlencoded({ extended: false })); app.use(express.urlencoded({ extended: false }));
app.use(express.json());
app.use(express.static(path.resolve(__dirname, "..", "web", "public"))); app.use(express.static(path.resolve(__dirname, "..", "web", "public")));
app.engine("eta", Eta.renderFile); app.engine("eta", Eta.renderFile);
@@ -307,13 +331,13 @@ function server(
return `<Match propname="rating" value="${value}"> return `<Match propname="rating" value="${value}">
<Ratings> <Ratings>
<Rating Id="${ratingAsInt( <Rating Id="${ratingAsInt(
nextLove nextLove
)}" AutoSkip="NEVER" OnSuccessStringId="LOVE_SUCCESS" StringId="LOVE"> )}" AutoSkip="NEVER" OnSuccessStringId="LOVE_SUCCESS" StringId="LOVE">
<Icon Controller="universal" LastModified="${LastModified}" Uri="${loveRatingIcon}" /> <Icon Controller="universal" LastModified="${LastModified}" Uri="${loveRatingIcon}" />
</Rating> </Rating>
<Rating Id="${-ratingAsInt( <Rating Id="${-ratingAsInt(
nextStar nextStar
)}" AutoSkip="NEVER" OnSuccessStringId="STAR_SUCCESS" StringId="STAR"> )}" AutoSkip="NEVER" OnSuccessStringId="STAR_SUCCESS" StringId="STAR">
<Icon Controller="universal" LastModified="${LastModified}" Uri="${starsRatingIcon}" /> <Icon Controller="universal" LastModified="${LastModified}" Uri="${starsRatingIcon}" />
</Rating> </Rating>
</Ratings> </Ratings>
@@ -327,9 +351,9 @@ function server(
<Match> <Match>
<imageSizeMap> <imageSizeMap>
${SONOS_RECOMMENDED_IMAGE_SIZES.map( ${SONOS_RECOMMENDED_IMAGE_SIZES.map(
(size) => (size) =>
`<sizeEntry size="${size}" substitution="/size/${size}"/>` `<sizeEntry size="${size}" substitution="/size/${size}"/>`
).join("")} ).join("")}
</imageSizeMap> </imageSizeMap>
</Match> </Match>
</PresentationMap> </PresentationMap>
@@ -338,9 +362,9 @@ function server(
<browseIconSizeMap> <browseIconSizeMap>
<sizeEntry size="0" substitution="/size/legacy"/> <sizeEntry size="0" substitution="/size/legacy"/>
${SONOS_RECOMMENDED_IMAGE_SIZES.map( ${SONOS_RECOMMENDED_IMAGE_SIZES.map(
(size) => (size) =>
`<sizeEntry size="${size}" substitution="/size/${size}"/>` `<sizeEntry size="${size}" substitution="/size/${size}"/>`
).join("")} ).join("")}
</browseIconSizeMap> </browseIconSizeMap>
</Match> </Match>
</PresentationMap> </PresentationMap>
@@ -374,7 +398,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": "*****" })}`
@@ -398,6 +422,14 @@ function server(
if (!serviceToken) { if (!serviceToken) {
return res.status(401).send(); return res.status(401).send();
} else { } else {
// Store session for scrobbling later (when Sonos reports playback)
streamSessions.set(id, {
serviceToken,
trackId: id,
timestamp: Date.now(),
});
logger.debug(`Stored stream session for track ${id}`);
return musicService return musicService
.login(serviceToken) .login(serviceToken)
.then((it) => .then((it) =>
@@ -406,13 +438,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 +471,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 +484,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,38 +531,40 @@ 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;
const spec = const spec =
size == "legacy" size == "legacy"
? { ? {
mimeType: "image/png", mimeType: "image/png",
responseFormatter: (svg: string): Promise<Buffer | string> => responseFormatter: (svg: string): Promise<Buffer | string> =>
sharp(Buffer.from(svg)).resize(80).png().toBuffer(), sharp(Buffer.from(svg)).resize(80).png().toBuffer(),
} }
: { : {
mimeType: "image/svg+xml", mimeType: "image/svg+xml",
responseFormatter: (svg: string): Promise<Buffer | string> => responseFormatter: (svg: string): Promise<Buffer | string> =>
Promise.resolve(svg), Promise.resolve(svg),
}; };
return Promise.resolve( return Promise.resolve(
icon icon
.apply( .apply(
features({ features({
viewPortIncreasePercent: 80,
...serverOpts.iconColors, ...serverOpts.iconColors,
text: text
}) })
) )
.apply(festivals(clock)) .apply(festivals(clock))
@@ -556,23 +592,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,61 +607,137 @@ function server(
return musicService return musicService
.login(serviceToken) .login(serviceToken)
.then((musicLibrary) => .then((musicLibrary) => {
Promise.all( if (urn.system == "external") {
urns.map((it) => { return serverOpts.externalImageResolver(urn.resource);
if (it.system == "external") { } else {
return serverOpts.externalImageResolver(it.resource); return musicLibrary.coverArt(urn, size);
} else { }
return musicLibrary.coverArt(it, size); })
} .then((coverArt) => {
}) if(coverArt) {
)
)
.then((coverArts) => coverArts.filter((it) => it))
.then(shuffle)
.then((coverArts) => {
if (coverArts.length == 1) {
const coverArt = coverArts[0]!;
res.status(200); res.status(200);
res.setHeader("content-type", coverArt.contentType); res.setHeader("content-type", coverArt.contentType);
return res.send(coverArt.data); return res.send(coverArt.data);
} else if (coverArts.length > 1) {
const gravity = [...GRAVITY_9];
return sharp({
create: {
width: size * 3,
height: size * 3,
channels: 3,
background: { r: 255, g: 255, b: 255 },
},
})
.composite(
takeWithRepeats(coverArts, 9).map((art) => ({
input: art?.data,
gravity: gravity.pop(),
}))
)
.png()
.toBuffer()
.then((image) => sharp(image).resize(size).png().toBuffer())
.then((image) => {
res.status(200);
res.setHeader("content-type", "image/png");
return res.send(image);
});
} else { } else {
return res.status(404).send(); return res.status(404).send();
} }
}) })
.catch((e: Error) => { .catch((e: Error) => {
logger.error(`Failed fetching image ${urns.join("&")}/size/${size}`, { logger.error(`Failed fetching image ${urn}/size/${size}`, {
cause: e, cause: e,
}); });
return res.status(500).send(); return res.status(500).send();
}); });
}); });
// Sonos Reporting Endpoint for playback analytics
app.post("/report/:version/timePlayed", async (req, res) => {
const version = req.params["version"];
logger.debug(`Received Sonos reporting event (v${version}): ${JSON.stringify(req.body)}`);
try {
// Sonos may send an array of reports or a single report with items array
const reports = Array.isArray(req.body) ? req.body : [req.body];
for (const report of reports) {
// Handle both direct report format and items array format
const items = report.items || [report];
for (const item of items) {
const {
reportId,
mediaUrl,
durationPlayedMillis,
positionMillis,
type,
} = item;
// Extract track ID from mediaUrl (format: /stream/track/{id} or x-sonos-http:track%3a{id}.mp3)
let trackId: string | undefined;
if (mediaUrl) {
// Try standard URL format first
const standardMatch = mediaUrl.match(/\/stream\/track\/([^?]+)/);
if (standardMatch) {
trackId = standardMatch[1];
} else {
// Try x-sonos-http format (track%3a{id}.mp3)
const sonosMatch = mediaUrl.match(/track%3[aA]([^.?&]+)/);
if (sonosMatch) {
trackId = sonosMatch[1];
}
}
}
if (!trackId) {
logger.warn(`Could not extract track ID from mediaUrl: ${mediaUrl}, full report: ${JSON.stringify(report)}`);
continue; // Skip this report, process next one
}
const durationPlayedSeconds = Math.floor((durationPlayedMillis || 0) / 1000);
logger.info(
`Sonos reporting: type=${type}, trackId=${trackId}, reportId=${reportId}, ` +
`durationPlayed=${durationPlayedSeconds}s, position=${positionMillis}ms`
);
// For "final" reports, determine if we should scrobble
if (type === "final" && durationPlayedSeconds > 0) {
// Retrieve authentication from stream session storage
const session = streamSessions.get(trackId!);
let serviceToken: string | undefined = session?.serviceToken;
if (!serviceToken) {
// Fallback: try to extract from Authorization header (if present)
const authHeader = req.headers["authorization"];
if (authHeader && authHeader.startsWith("Bearer ")) {
const token = authHeader.substring(7);
const smapiToken = serverOpts.smapiTokenStore.get(token);
if (smapiToken) {
serviceToken = pipe(
smapiAuthTokens.verify({ token, key: smapiToken.key }),
E.getOrElseW(() => undefined)
);
}
}
}
if (serviceToken) {
await musicService.login(serviceToken).then((musicLibrary) => {
// Get track duration to determine scrobbling threshold
return musicLibrary.track(trackId!).then((track) => {
const shouldScrobble =
(track.duration < 30 && durationPlayedSeconds >= 10) ||
(track.duration >= 30 && durationPlayedSeconds >= 30);
if (shouldScrobble) {
logger.info(`Scrobbling track ${trackId} after ${durationPlayedSeconds}s playback`);
return musicLibrary.scrobble(trackId!);
} else {
logger.debug(
`Not scrobbling track ${trackId}: duration=${track.duration}s, played=${durationPlayedSeconds}s`
);
return Promise.resolve(false);
}
});
}).catch((e) => {
logger.error(`Failed to process scrobble for track ${trackId}`, { error: e });
});
} else {
logger.debug("No authentication available for reporting endpoint scrobble");
}
}
}
}
return res.status(200).json({ status: "ok" });
} catch (error) {
logger.error("Error processing Sonos reporting event", { error });
return res.status(500).json({ status: "error" });
}
});
bindSmapiSoapServiceToExpress( bindSmapiSoapServiceToExpress(
app, app,
SOAP_PATH, SOAP_PATH,
@@ -647,7 +747,10 @@ function server(
apiTokens, apiTokens,
clock, clock,
i8n, i8n,
serverOpts.smapiAuthTokens serverOpts.smapiAuthTokens,
serverOpts.smapiTokenStore,
serverOpts.logRequests,
serverOpts.tokenCleanupIntervalMinutes
); );
if (serverOpts.applyContextPath) { if (serverOpts.applyContextPath) {

View File

@@ -15,8 +15,10 @@ import {
AlbumSummary, AlbumSummary,
ArtistSummary, ArtistSummary,
Genre, Genre,
Year,
MusicService, MusicService,
Playlist, Playlist,
RadioStation,
Rating, Rating,
slice2, slice2,
Track, Track,
@@ -26,7 +28,7 @@ import { Clock } from "./clock";
import { URLBuilder } from "./url_builder"; import { URLBuilder } from "./url_builder";
import { asLANGs, I8N } from "./i8n"; import { asLANGs, I8N } from "./i8n";
import { ICON, iconForGenre } from "./icon"; import { ICON, iconForGenre } from "./icon";
import _, { uniq } from "underscore"; import _ from "underscore";
import { BUrn, formatForURL } from "./burn"; import { BUrn, formatForURL } from "./burn";
import { import {
isExpiredTokenError, isExpiredTokenError,
@@ -34,7 +36,11 @@ import {
SmapiAuthTokens, SmapiAuthTokens,
SMAPI_FAULT_LOGIN_UNAUTHORIZED, SMAPI_FAULT_LOGIN_UNAUTHORIZED,
ToSmapiFault, ToSmapiFault,
SmapiToken,
} from "./smapi_auth"; } from "./smapi_auth";
import { InvalidTokenError } from "./smapi_auth";
import { IncomingHttpHeaders } from "http2";
import { SmapiTokenStore } from "./smapi_token_store";
export const LOGIN_ROUTE = "/login"; export const LOGIN_ROUTE = "/login";
export const CREATE_REGISTRATION_ROUTE = "/registration/add"; export const CREATE_REGISTRATION_ROUTE = "/registration/add";
@@ -60,7 +66,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 = {
@@ -159,17 +165,20 @@ class SonosSoap {
bonobUrl: URLBuilder; bonobUrl: URLBuilder;
smapiAuthTokens: SmapiAuthTokens; smapiAuthTokens: SmapiAuthTokens;
clock: Clock; clock: Clock;
tokenStore: SmapiTokenStore;
constructor( constructor(
bonobUrl: URLBuilder, bonobUrl: URLBuilder,
linkCodes: LinkCodes, linkCodes: LinkCodes,
smapiAuthTokens: SmapiAuthTokens, smapiAuthTokens: SmapiAuthTokens,
clock: Clock clock: Clock,
tokenStore: SmapiTokenStore
) { ) {
this.bonobUrl = bonobUrl; this.bonobUrl = bonobUrl;
this.linkCodes = linkCodes; this.linkCodes = linkCodes;
this.smapiAuthTokens = smapiAuthTokens; this.smapiAuthTokens = smapiAuthTokens;
this.clock = clock; this.clock = clock;
this.tokenStore = tokenStore;
} }
getAppLink(): GetAppLinkResult { getAppLink(): GetAppLinkResult {
@@ -191,6 +200,11 @@ class SonosSoap {
}; };
} }
reportAccountAction = (args: any, _headers: any) => {
logger.info('Sonos reportAccountAction: ' + JSON.stringify(args));
return {};
}
getDeviceAuthToken({ getDeviceAuthToken({
linkCode, linkCode,
}: { }: {
@@ -231,6 +245,18 @@ class SonosSoap {
}; };
} }
} }
getCredentialsForToken(token: string): SmapiToken | undefined {
logger.debug("getCredentialsForToken called with: " + token);
logger.debug("Current tokens: " + JSON.stringify(this.tokenStore.getAll()));
return this.tokenStore.get(token);
}
associateCredentialsForToken(token: string, fullSmapiToken: SmapiToken, oldToken?:string) {
logger.debug("Adding token: " + token + " " + JSON.stringify(fullSmapiToken));
if(oldToken) {
this.tokenStore.delete(oldToken);
}
this.tokenStore.set(token, fullSmapiToken);
}
} }
export type ContainerType = "container" | "search" | "albumList"; export type ContainerType = "container" | "search" | "albumList";
@@ -243,18 +269,27 @@ 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,
canEnumerate: true,
attributes: { attributes: {
readOnly: false, readOnly: false,
userContent: false, userContent: false,
@@ -262,29 +297,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 +312,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 +326,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 +334,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 +352,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 +370,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) {
@@ -398,9 +405,33 @@ function bindSmapiSoapServiceToExpress(
apiKeys: APITokens, apiKeys: APITokens,
clock: Clock, clock: Clock,
i8n: I8N, i8n: I8N,
smapiAuthTokens: SmapiAuthTokens smapiAuthTokens: SmapiAuthTokens,
tokenStore: SmapiTokenStore,
_logRequests: boolean,
tokenCleanupIntervalMinutes: number = 60
) { ) {
const sonosSoap = new SonosSoap(bonobUrl, linkCodes, smapiAuthTokens, clock); const sonosSoap = new SonosSoap(bonobUrl, linkCodes, smapiAuthTokens, clock, tokenStore);
// Clean up expired tokens on startup
try {
const cleaned = tokenStore.cleanupExpired(smapiAuthTokens);
if (cleaned > 0) {
logger.info(`Cleaned up ${cleaned} expired token(s) on startup`);
}
} catch (error) {
logger.error("Failed to cleanup expired tokens on startup", { error });
}
// Clean up expired tokens periodically
const cleanupIntervalMs = tokenCleanupIntervalMinutes * 60 * 1000;
logger.info(`Token cleanup will run every ${tokenCleanupIntervalMinutes} minute(s)`);
setInterval(() => {
try {
tokenStore.cleanupExpired(smapiAuthTokens);
} catch (error) {
logger.error("Failed to cleanup expired tokens", { error });
}
}, cleanupIntervalMs).unref(); // Don't prevent process exit
const urlWithToken = (accessToken: string) => const urlWithToken = (accessToken: string) =>
bonobUrl.append({ bonobUrl.append({
@@ -413,18 +444,39 @@ function bindSmapiSoapServiceToExpress(
const credentialsFrom = E.fromNullable(new MissingLoginTokenError()); const credentialsFrom = E.fromNullable(new MissingLoginTokenError());
return pipe( return pipe(
credentialsFrom(credentials), credentialsFrom(credentials),
E.chain((credentials) => E.chain((credentials) => {
pipe( // Check if token/key is associated with a user
const smapiToken = sonosSoap.getCredentialsForToken(credentials.loginToken.token);
if (!smapiToken) {
logger.warn("Token not found in store - possibly old/expired token from Sonos cache. Try removing and re-adding the service in Sonos app.");
return E.left(new InvalidTokenError("Token not found"));
}
// If credentials don't have a key, use the stored one
const effectiveKey = credentials.loginToken.key || smapiToken.key;
if (smapiToken.key !== effectiveKey) {
logger.warn("Token key mismatch", { storedKey: smapiToken.key, providedKey: effectiveKey });
return E.left(new InvalidTokenError("Token key mismatch"));
}
return pipe(
smapiAuthTokens.verify({ smapiAuthTokens.verify({
token: credentials.loginToken.token, token: credentials.loginToken.token,
key: credentials.loginToken.key, key: effectiveKey,
}), }),
E.map((serviceToken) => ({ E.map((serviceToken) => ({
serviceToken, serviceToken,
credentials, credentials: {
...credentials,
loginToken: {
...credentials.loginToken,
key: effectiveKey,
},
},
})) }))
) );
), }),
E.map(({ serviceToken, credentials }) => ({ E.map(({ serviceToken, credentials }) => ({
serviceToken, serviceToken,
credentials, credentials,
@@ -433,7 +485,49 @@ function bindSmapiSoapServiceToExpress(
); );
}; };
const login = async (credentials?: Credentials) => { const swapToken = (expiredToken: string | undefined) => (newToken: SmapiToken) => {
logger.debug("oldToken: " + expiredToken);
logger.debug("newToken: " + JSON.stringify(newToken));
if (expiredToken) {
sonosSoap.associateCredentialsForToken(newToken.token, newToken, expiredToken);
} else {
sonosSoap.associateCredentialsForToken(newToken.token, newToken);
}
return TE.right(newToken);
}
const useHeaderIfPresent = (credentials?: Credentials, headers?: IncomingHttpHeaders) => {
const headersProvidedWithToken = headers!==null && headers!== undefined && headers["authorization"];
if(headersProvidedWithToken) {
logger.debug("Will use authorization header");
const bearer = headers["authorization"];
const token = bearer?.split(" ")[1];
if(token) {
const credsForToken = sonosSoap.getCredentialsForToken(token);
if(credsForToken==undefined) {
logger.debug("No creds for "+JSON.stringify(token));
} else {
credentials = {
...credentials!,
loginToken: {
...credentials?.loginToken!,
token: credsForToken.token,
key: credsForToken.key,
}
}
logger.debug("Updated credentials to " + JSON.stringify(credentials));
}
}
}
return credentials;
}
const login = async (credentials?: Credentials, headers?: IncomingHttpHeaders) => {
const credentialsProvidedWithoutAuthToken = credentials && credentials.loginToken.token==null;
if(credentialsProvidedWithoutAuthToken) {
credentials = useHeaderIfPresent(credentials, headers);
}
const authOrFail = pipe( const authOrFail = pipe(
auth(credentials), auth(credentials),
E.getOrElseW((fault) => fault) E.getOrElseW((fault) => fault)
@@ -446,9 +540,16 @@ function bindSmapiSoapServiceToExpress(
throw SMAPI_FAULT_LOGIN_UNAUTHORIZED; throw SMAPI_FAULT_LOGIN_UNAUTHORIZED;
}); });
} else if (isExpiredTokenError(authOrFail)) { } else if (isExpiredTokenError(authOrFail)) {
// Don't pass old token here to avoid circular reference issues with Jest/SOAP
// Old expired tokens will be cleaned up by TTL or manual cleanup later
logger.info("Token expired, attempting refresh...");
throw await pipe( throw await pipe(
musicService.refreshToken(authOrFail.expiredToken), musicService.refreshToken(authOrFail.expiredToken),
TE.map((it) => smapiAuthTokens.issue(it.serviceToken)), TE.map((it) => {
logger.info("Token refresh successful, issuing new SMAPI token");
return smapiAuthTokens.issue(it.serviceToken);
}),
TE.tap(swapToken(undefined)),
TE.map((newToken) => ({ TE.map((newToken) => ({
Fault: { Fault: {
faultcode: "Client.TokenRefreshRequired", faultcode: "Client.TokenRefreshRequired",
@@ -461,9 +562,10 @@ function bindSmapiSoapServiceToExpress(
}, },
}, },
})), })),
TE.getOrElse(() => TE.getOrElse((err) => {
T.of(SMAPI_FAULT_LOGIN_UNAUTHORIZED) logger.error("Token refresh failed", { error: err });
) return T.of(SMAPI_FAULT_LOGIN_UNAUTHORIZED);
})
)(); )();
} else { } else {
throw authOrFail.toSmapiFault(); throw authOrFail.toSmapiFault();
@@ -477,8 +579,18 @@ function bindSmapiSoapServiceToExpress(
Sonos: { Sonos: {
SonosSoap: { SonosSoap: {
getAppLink: () => sonosSoap.getAppLink(), getAppLink: () => sonosSoap.getAppLink(),
getDeviceAuthToken: ({ linkCode }: { linkCode: string }) => reportAccountAction: (args: any) =>
sonosSoap.getDeviceAuthToken({ linkCode }), sonosSoap.reportAccountAction(args, undefined),
getDeviceAuthToken: ({ linkCode }: { linkCode: string}) =>{
const deviceAuthTokenResult = sonosSoap.getDeviceAuthToken({ linkCode });
const smapiToken:SmapiToken = {
token: deviceAuthTokenResult.getDeviceAuthTokenResult.authToken,
key: deviceAuthTokenResult.getDeviceAuthTokenResult.privateKey
}
sonosSoap.associateCredentialsForToken(smapiToken.token, smapiToken);
return deviceAuthTokenResult;
},
getLastUpdate: () => ({ getLastUpdate: () => ({
getLastUpdateResult: { getLastUpdateResult: {
autoRefreshEnabled: true, autoRefreshEnabled: true,
@@ -487,9 +599,11 @@ function bindSmapiSoapServiceToExpress(
pollInterval: 60, pollInterval: 60,
}, },
}), }),
refreshAuthToken: async (_, _2, soapyHeaders: SoapyHeaders) => { refreshAuthToken: async (_, _2, soapyHeaders: SoapyHeaders,
{ headers }: Pick<Request, "headers">) => {
const creds = useHeaderIfPresent(soapyHeaders?.credentials, headers);
const serviceToken = pipe( const serviceToken = pipe(
auth(soapyHeaders?.credentials), auth(creds),
E.fold( E.fold(
(fault) => (fault) =>
isExpiredTokenError(fault) isExpiredTokenError(fault)
@@ -501,9 +615,12 @@ function bindSmapiSoapServiceToExpress(
throw fault.toSmapiFault(); throw fault.toSmapiFault();
}) })
); );
// Don't pass old token here to avoid circular reference issues with Jest/SOAP
// Old expired tokens will be cleaned up by TTL or manual cleanup later
return pipe( return pipe(
musicService.refreshToken(serviceToken), musicService.refreshToken(serviceToken),
TE.map((it) => smapiAuthTokens.issue(it.serviceToken)), TE.map((it) => smapiAuthTokens.issue(it.serviceToken)),
TE.tap(swapToken(undefined)), // ignores the return value, like a tee or peek
TE.map((it) => ({ TE.map((it) => ({
refreshAuthTokenResult: { refreshAuthTokenResult: {
authToken: it.token, authToken: it.token,
@@ -518,49 +635,74 @@ function bindSmapiSoapServiceToExpress(
getMediaURI: async ( getMediaURI: async (
{ id }: { id: string }, { id }: { id: string },
_, _,
soapyHeaders: SoapyHeaders soapyHeaders: SoapyHeaders,
) => { headers }: Pick<Request, "headers">
login(soapyHeaders?.credentials) ) => {
return login(soapyHeaders?.credentials, headers)
.then(splitId(id)) .then(splitId(id))
.then(({ credentials, type, typeId }) => ({ .then(({ musicLibrary, credentials, type, typeId }) => {
getMediaURIResult: bonobUrl switch (type) {
.append({ case "internetRadioStation":
pathname: `/stream/${type}/${typeId}`, return musicLibrary.radioStation(typeId).then((it) => ({
}) getMediaURIResult: it.url,
.href(), }));
httpHeaders: [ case "track":
{ return {
httpHeader: { getMediaURIResult: bonobUrl
header: "bnbt", .append({
value: credentials.loginToken.token, pathname: `/stream/${type}/${typeId}`,
}, })
}, .href(),
{ httpHeaders: [
httpHeader: { {
header: "bnbk", httpHeader: {
value: credentials.loginToken.key, header: "bnbt",
}, value: credentials.loginToken.token,
}, },
], },
})), {
httpHeader: {
header: "bnbk",
value: credentials.loginToken.key,
},
},
],
};
default:
throw `Unsupported type:${type}`;
}
});
},
getMediaMetadata: async ( getMediaMetadata: async (
{ id }: { id: string }, { id }: { id: string },
_, _,
soapyHeaders: SoapyHeaders soapyHeaders: SoapyHeaders,
) => { headers }: Pick<Request, "headers">
login(soapyHeaders?.credentials) ) => {
return login(soapyHeaders?.credentials, headers)
.then(splitId(id)) .then(splitId(id))
.then(async ({ musicLibrary, apiKey, typeId }) => .then(async ({ musicLibrary, apiKey, type, typeId }) => {
musicLibrary.track(typeId!).then((it) => ({ switch (type) {
getMediaMetadataResult: track(urlWithToken(apiKey), it), case "internetRadioStation":
})) return musicLibrary.radioStation(typeId).then((it) => ({
), getMediaMetadataResult: internetRadioStation(it),
}));
case "track":
return musicLibrary.track(typeId!).then((it) => ({
getMediaMetadataResult: track(urlWithToken(apiKey), it),
}));
default:
throw `Unsupported type:${type}`;
}
});
},
search: async ( search: async (
{ id, term }: { id: string; term: string }, { id, term }: { id: string; term: string },
_, _,
soapyHeaders: SoapyHeaders soapyHeaders: SoapyHeaders,
) => { headers }: Pick<Request, "headers">
login(soapyHeaders?.credentials) ) => {
return login(soapyHeaders?.credentials, headers)
.then(splitId(id)) .then(splitId(id))
.then(async ({ musicLibrary, apiKey }) => { .then(async ({ musicLibrary, apiKey }) => {
switch (id) { switch (id) {
@@ -586,15 +728,16 @@ function bindSmapiSoapServiceToExpress(
return musicLibrary.searchTracks(term).then((it) => return musicLibrary.searchTracks(term).then((it) =>
searchResult({ searchResult({
count: it.length, count: it.length,
mediaCollection: it.map((aTrack) => mediaMetadata: it.map((aTrack) =>
album(urlWithToken(apiKey), aTrack.album) track(urlWithToken(apiKey), aTrack)
), ),
}) })
); );
default: default:
throw `Unsupported search by:${id}`; throw `Unsupported search by:${id}`;
} }
}), });
},
getExtendedMetadata: async ( getExtendedMetadata: async (
{ {
id, id,
@@ -603,9 +746,10 @@ function bindSmapiSoapServiceToExpress(
}: // recursive, }: // recursive,
{ id: string; index: number; count: number; recursive: boolean }, { id: string; index: number; count: number; recursive: boolean },
_, _,
soapyHeaders: SoapyHeaders soapyHeaders: SoapyHeaders,
) => { headers }: Pick<Request, "headers">
login(soapyHeaders?.credentials) ) => {
return login(soapyHeaders?.credentials, headers)
.then(splitId(id)) .then(splitId(id))
.then(async ({ musicLibrary, apiKey, type, typeId }) => { .then(async ({ musicLibrary, apiKey, type, typeId }) => {
const paging = { _index: index, _count: count }; const paging = { _index: index, _count: count };
@@ -662,10 +806,35 @@ function bindSmapiSoapServiceToExpress(
// </getExtendedMetadataResult> // </getExtendedMetadataResult>
}, },
})); }));
case "playlists":
return musicLibrary
.playlists()
.then((it) =>
Promise.all(
it.map((playlist) => ({
id: playlist.id,
name: playlist.name,
coverArt: playlist.coverArt,
entries: [],
}))
)
)
.then(slice2(paging))
.then(([page, total]) => ({
getExtendedMetadataResult: {
count: page.length,
index: paging._index,
total,
mediaCollection: page.map((it) =>
playlist(urlWithToken(apiKey), it)
),
},
}));
default: default:
throw `Unsupported getExtendedMetadata id=${id}`; throw `Unsupported getExtendedMetadata id=${id}`;
} }
}), });
},
getMetadata: async ( getMetadata: async (
{ {
id, id,
@@ -676,12 +845,12 @@ function bindSmapiSoapServiceToExpress(
_, _,
soapyHeaders: SoapyHeaders, soapyHeaders: SoapyHeaders,
{ headers }: Pick<Request, "headers"> { headers }: Pick<Request, "headers">
) => ) => {
login(soapyHeaders?.credentials) const acceptLanguage = headers["accept-language"];
return login(soapyHeaders?.credentials, headers)
.then(splitId(id)) .then(splitId(id))
.then(({ musicLibrary, apiKey, type, typeId }) => { .then(({ musicLibrary, apiKey, type, typeId }) => {
const paging = { _index: index, _count: count }; const paging = { _index: index, _count: count };
const acceptLanguage = headers["accept-language"];
logger.debug( logger.debug(
`Fetching metadata type=${type}, typeId=${typeId}, acceptLanguage=${acceptLanguage}` `Fetching metadata type=${type}, typeId=${typeId}, acceptLanguage=${acceptLanguage}`
); );
@@ -736,7 +905,8 @@ function bindSmapiSoapServiceToExpress(
id: "playlists", id: "playlists",
title: lang("playlists"), title: lang("playlists"),
albumArtURI: iconArtURI(bonobUrl, "playlists").href(), albumArtURI: iconArtURI(bonobUrl, "playlists").href(),
itemType: "playlist", itemType: "container",
canEnumerate: true,
attributes: { attributes: {
readOnly: false, readOnly: false,
userContent: true, userContent: true,
@@ -749,6 +919,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 +952,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 +1002,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 +1039,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 +1083,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 +1124,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!)
@@ -944,13 +1166,15 @@ function bindSmapiSoapServiceToExpress(
default: default:
throw `Unsupported getMetadata id=${id}`; throw `Unsupported getMetadata id=${id}`;
} }
}), });
},
createContainer: async ( createContainer: async (
{ title, seedId }: { title: string; seedId: string | undefined }, { title, seedId }: { title: string; seedId: string | undefined },
_, _,
soapyHeaders: SoapyHeaders soapyHeaders: SoapyHeaders,
) => { headers }: Pick<Request, "headers">
login(soapyHeaders?.credentials) ) => {
return login(soapyHeaders?.credentials, headers)
.then(({ musicLibrary }) => .then(({ musicLibrary }) =>
musicLibrary musicLibrary
.createPlaylist(title) .createPlaylist(title)
@@ -970,32 +1194,38 @@ function bindSmapiSoapServiceToExpress(
id: `playlist:${it.id}`, id: `playlist:${it.id}`,
updateId: "", updateId: "",
}, },
})), }));
},
deleteContainer: async ( deleteContainer: async (
{ id }: { id: string }, { id }: { id: string },
_, _,
soapyHeaders: SoapyHeaders soapyHeaders: SoapyHeaders,
) => { headers }: Pick<Request, "headers">
login(soapyHeaders?.credentials) ) => {
return login(soapyHeaders?.credentials, headers)
.then(({ musicLibrary }) => musicLibrary.deletePlaylist(id)) .then(({ musicLibrary }) => musicLibrary.deletePlaylist(id))
.then((_) => ({ deleteContainerResult: {} })), .then((_) => ({ deleteContainerResult: {} }));
},
addToContainer: async ( addToContainer: async (
{ id, parentId }: { id: string; parentId: string }, { id, parentId }: { id: string; parentId: string },
_, _,
soapyHeaders: SoapyHeaders soapyHeaders: SoapyHeaders,
) => { headers }: Pick<Request, "headers">
login(soapyHeaders?.credentials) ) => {
return login(soapyHeaders?.credentials, headers)
.then(splitId(id)) .then(splitId(id))
.then(({ musicLibrary, typeId }) => .then(({ musicLibrary, typeId }) =>
musicLibrary.addToPlaylist(parentId.split(":")[1]!, typeId) musicLibrary.addToPlaylist(parentId.split(":")[1]!, typeId)
) )
.then((_) => ({ addToContainerResult: { updateId: "" } })), .then((_) => ({ addToContainerResult: { updateId: "" } }));
},
removeFromContainer: async ( removeFromContainer: async (
{ id, indices }: { id: string; indices: string }, { id, indices }: { id: string; indices: string },
_, _,
soapyHeaders: SoapyHeaders soapyHeaders: SoapyHeaders,
) => { headers }: Pick<Request, "headers">
login(soapyHeaders?.credentials) ) => {
return login(soapyHeaders?.credentials, headers)
.then(splitId(id)) .then(splitId(id))
.then((it) => ({ .then((it) => ({
...it, ...it,
@@ -1012,25 +1242,29 @@ function bindSmapiSoapServiceToExpress(
musicLibrary.removeFromPlaylist(typeId, indices); musicLibrary.removeFromPlaylist(typeId, indices);
} }
}) })
.then((_) => ({ removeFromContainerResult: { updateId: "" } })), .then((_) => ({ removeFromContainerResult: { updateId: "" } }));
},
rateItem: async ( rateItem: async (
{ id, rating }: { id: string; rating: number }, { id, rating }: { id: string; rating: number },
_, _,
soapyHeaders: SoapyHeaders soapyHeaders: SoapyHeaders,
) => { headers }: Pick<Request, "headers">
login(soapyHeaders?.credentials) ) => {
return login(soapyHeaders?.credentials, headers)
.then(splitId(id)) .then(splitId(id))
.then(({ musicLibrary, typeId }) => .then(({ musicLibrary, typeId }) =>
musicLibrary.rate(typeId, ratingFromInt(Math.abs(rating))) musicLibrary.rate(typeId, ratingFromInt(Math.abs(rating)))
) )
.then((_) => ({ rateItemResult: { shouldSkip: false } })), .then((_) => ({ rateItemResult: { shouldSkip: false } }));
},
setPlayedSeconds: async ( setPlayedSeconds: async (
{ id, seconds }: { id: string; seconds: string }, { id, seconds }: { id: string; seconds: string },
_, _,
soapyHeaders: SoapyHeaders soapyHeaders: SoapyHeaders,
) => { headers }: Pick<Request, "headers">
login(soapyHeaders?.credentials) ) => {
return login(soapyHeaders?.credentials, headers)
.then(splitId(id)) .then(splitId(id))
.then(({ musicLibrary, type, typeId }) => { .then(({ musicLibrary, type, typeId }) => {
switch (type) { switch (type) {
@@ -1052,7 +1286,49 @@ function bindSmapiSoapServiceToExpress(
}) })
.then((_) => ({ .then((_) => ({
setPlayedSecondsResult: {}, setPlayedSecondsResult: {},
})), }));
},
reportPlaySeconds: async (
{ id, seconds }: { id: string; seconds: string },
_,
soapyHeaders: SoapyHeaders,
{ headers }: Pick<Request, "headers">
) => {
return login(soapyHeaders?.credentials, headers)
.then(splitId(id))
.then(({ type, typeId }) => {
if (type === "track") {
logger.debug(`reportPlaySeconds called for track ${typeId}, seconds: ${seconds}`);
// Return interval of 30 seconds for next update
return Promise.resolve(true);
}
return Promise.resolve(true);
})
.then((_) => ({
reportPlaySecondsResult: { interval: 30 },
}));
},
reportPlayStatus: async (
{ id, status }: { id: string; status: string },
_,
soapyHeaders: SoapyHeaders,
{ headers }: Pick<Request, "headers">
) => {
return login(soapyHeaders?.credentials, headers)
.then(splitId(id))
.then(({ musicLibrary, type, typeId }) => {
if (type === "track") {
logger.info(`reportPlayStatus called for track ${typeId}, status: ${status}`);
if (status === "PLAY_START" || status === "PAUSED_PLAYBACK") {
return musicLibrary.nowPlaying(typeId);
}
}
return Promise.resolve(true);
})
.then((_) => ({}));
},
}, },
}, },
}, },
@@ -1066,8 +1342,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

@@ -4,6 +4,8 @@ import { v4 as uuid } from "uuid";
import { b64Decode, b64Encode } from "./b64"; import { b64Decode, b64Encode } from "./b64";
import { Clock } from "./clock"; import { Clock } from "./clock";
import logger from "./logger";
export type SmapiFault = { Fault: { faultcode: string; faultstring: string } }; export type SmapiFault = { Fault: { faultcode: string; faultstring: string } };
export type SmapiRefreshTokenResultFault = SmapiFault & { export type SmapiRefreshTokenResultFault = SmapiFault & {
Fault: { Fault: {
@@ -14,6 +16,7 @@ export type SmapiRefreshTokenResultFault = SmapiFault & {
}; };
function isError(thing: any): thing is Error { function isError(thing: any): thing is Error {
logger.debug("isError check", { thing });
return thing.name && thing.message; return thing.name && thing.message;
} }
@@ -151,6 +154,13 @@ export class JWTSmapiLoginTokens implements SmapiAuthTokens {
}; };
verify = (smapiToken: SmapiToken): E.Either<ToSmapiFault, string> => { verify = (smapiToken: SmapiToken): E.Either<ToSmapiFault, string> => {
logger.debug("Verifying JWT", {
token: smapiToken.token,
key: smapiToken.key,
secret: this.secret,
version: this.version,
secretKey: this.secret + this.version + smapiToken.key,
});
try { try {
return E.right( return E.right(
( (
@@ -161,7 +171,9 @@ export class JWTSmapiLoginTokens implements SmapiAuthTokens {
).serviceToken ).serviceToken
); );
} catch (e) { } catch (e) {
const err = e as Error;
if (isTokenExpiredError(e)) { if (isTokenExpiredError(e)) {
logger.debug("JWT token expired, will attempt refresh", { expiredAt: (e as TokenExpiredError).expiredAt });
const serviceToken = ( const serviceToken = (
jwt.verify( jwt.verify(
smapiToken.token, smapiToken.token,
@@ -170,8 +182,11 @@ export class JWTSmapiLoginTokens implements SmapiAuthTokens {
) as any ) as any
).serviceToken; ).serviceToken;
return E.left(new ExpiredTokenError(serviceToken)); return E.left(new ExpiredTokenError(serviceToken));
} else if (isError(e)) return E.left(new InvalidTokenError(e.message)); } else {
else return E.left(new InvalidTokenError("Failed to verify token")); logger.warn("JWT verification failed - token may be invalid or from different secret", { message: err.message });
if (isError(e)) return E.left(new InvalidTokenError(err.message));
else return E.left(new InvalidTokenError("Failed to verify token"));
}
} }
}; };
} }

166
src/smapi_token_store.ts Normal file
View File

@@ -0,0 +1,166 @@
import fs from "fs";
import path from "path";
import logger from "./logger";
import { SmapiToken, SmapiAuthTokens } from "./smapi_auth";
import { either as E } from "fp-ts";
export { SQLiteSmapiTokenStore } from "./sqlite_smapi_token_store";
export interface SmapiTokenStore {
get(token: string): SmapiToken | undefined;
set(token: string, fullSmapiToken: SmapiToken): void;
delete(token: string): void;
getAll(): { [tokenKey: string]: SmapiToken };
cleanupExpired(smapiAuthTokens: SmapiAuthTokens): number;
}
export class InMemorySmapiTokenStore implements SmapiTokenStore {
private tokens: { [tokenKey: string]: SmapiToken } = {};
get(token: string): SmapiToken | undefined {
return this.tokens[token];
}
set(token: string, fullSmapiToken: SmapiToken): void {
this.tokens[token] = fullSmapiToken;
}
delete(token: string): void {
delete this.tokens[token];
}
getAll(): { [tokenKey: string]: SmapiToken } {
return this.tokens;
}
cleanupExpired(smapiAuthTokens: SmapiAuthTokens): number {
const tokenKeys = Object.keys(this.tokens);
let deletedCount = 0;
for (const tokenKey of tokenKeys) {
const smapiToken = this.tokens[tokenKey];
if (smapiToken) {
const verifyResult = smapiAuthTokens.verify(smapiToken);
// Only delete if token verification fails with InvalidTokenError
// Do NOT delete ExpiredTokenError as those can still be refreshed
if (E.isLeft(verifyResult)) {
const error = verifyResult.left;
// Only delete invalid tokens, not expired ones (which can be refreshed)
if (error._tag === 'InvalidTokenError') {
logger.debug(`Deleting invalid token from in-memory store`);
delete this.tokens[tokenKey];
deletedCount++;
}
}
}
}
if (deletedCount > 0) {
logger.info(`Cleaned up ${deletedCount} invalid token(s) from in-memory store`);
}
return deletedCount;
}
}
export class FileSmapiTokenStore implements SmapiTokenStore {
private tokens: { [tokenKey: string]: SmapiToken } = {};
private readonly filePath: string;
constructor(filePath: string) {
this.filePath = filePath;
this.loadFromFile();
}
private loadFromFile(): void {
try {
// Ensure the directory exists
const dir = path.dirname(this.filePath);
if (!fs.existsSync(dir)) {
fs.mkdirSync(dir, { recursive: true });
logger.info(`Created token storage directory: ${dir}`);
}
// Load existing tokens if file exists
if (fs.existsSync(this.filePath)) {
const data = fs.readFileSync(this.filePath, "utf8");
this.tokens = JSON.parse(data);
logger.info(
`Loaded ${Object.keys(this.tokens).length} token(s) from ${this.filePath}`
);
} else {
logger.info(`No existing token file found at ${this.filePath}, starting fresh`);
this.tokens = {};
this.saveToFile();
}
} catch (error) {
logger.error(`Failed to load tokens from ${this.filePath}`, { error });
this.tokens = {};
}
}
private saveToFile(): void {
try {
// Ensure the directory exists before writing
const dir = path.dirname(this.filePath);
if (!fs.existsSync(dir)) {
fs.mkdirSync(dir, { recursive: true });
logger.info(`Created token storage directory: ${dir}`);
}
const data = JSON.stringify(this.tokens, null, 2);
fs.writeFileSync(this.filePath, data, "utf8");
logger.debug(`Saved ${Object.keys(this.tokens).length} token(s) to ${this.filePath}`);
} catch (error) {
logger.error(`Failed to save tokens to ${this.filePath}`, { error });
}
}
get(token: string): SmapiToken | undefined {
return this.tokens[token];
}
set(token: string, fullSmapiToken: SmapiToken): void {
this.tokens[token] = fullSmapiToken;
this.saveToFile();
}
delete(token: string): void {
delete this.tokens[token];
this.saveToFile();
}
getAll(): { [tokenKey: string]: SmapiToken } {
return this.tokens;
}
cleanupExpired(smapiAuthTokens: SmapiAuthTokens): number {
const tokenKeys = Object.keys(this.tokens);
let deletedCount = 0;
for (const tokenKey of tokenKeys) {
const smapiToken = this.tokens[tokenKey];
if (smapiToken) {
const verifyResult = smapiAuthTokens.verify(smapiToken);
// Only delete if token verification fails with InvalidTokenError
// Do NOT delete ExpiredTokenError as those can still be refreshed
if (E.isLeft(verifyResult)) {
const error = verifyResult.left;
// Only delete invalid tokens, not expired ones (which can be refreshed)
if (error._tag === 'InvalidTokenError') {
logger.debug(`Deleting invalid token from file store`);
delete this.tokens[tokenKey];
deletedCount++;
}
}
}
}
if (deletedCount > 0) {
logger.info(`Cleaned up ${deletedCount} invalid token(s) from file store`);
this.saveToFile();
}
return deletedCount;
}
}

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

@@ -0,0 +1,200 @@
import Database from "better-sqlite3";
import path from "path";
import fs from "fs";
import logger from "./logger";
import { SmapiToken, SmapiAuthTokens } from "./smapi_auth";
import { either as E } from "fp-ts";
import { SmapiTokenStore } from "./smapi_token_store";
export class SQLiteSmapiTokenStore implements SmapiTokenStore {
private db!: Database.Database;
private readonly dbPath: string;
constructor(dbPath: string) {
this.dbPath = dbPath;
this.initializeDatabase();
}
private initializeDatabase(): void {
try {
// Ensure the directory exists
const dir = path.dirname(this.dbPath);
if (!fs.existsSync(dir)) {
fs.mkdirSync(dir, { recursive: true });
logger.info(`Created token storage directory: ${dir}`);
}
// Open database connection
this.db = new Database(this.dbPath);
// Create table if it doesn't exist
this.db.exec(`
CREATE TABLE IF NOT EXISTS smapi_tokens (
token_key TEXT PRIMARY KEY,
token TEXT NOT NULL,
key TEXT NOT NULL,
created_at INTEGER NOT NULL DEFAULT (strftime('%s', 'now'))
)
`);
// Create index for faster lookups
this.db.exec(`
CREATE INDEX IF NOT EXISTS idx_created_at ON smapi_tokens(created_at)
`);
const count = this.db.prepare("SELECT COUNT(*) as count FROM smapi_tokens").get() as { count: number };
logger.info(`SQLite token store initialized at ${this.dbPath} with ${count.count} token(s)`);
} catch (error) {
logger.error(`Failed to initialize SQLite token store at ${this.dbPath}`, { error });
throw error;
}
}
get(tokenKey: string): SmapiToken | undefined {
try {
const stmt = this.db.prepare("SELECT token, key FROM smapi_tokens WHERE token_key = ?");
const row = stmt.get(tokenKey) as { token: string; key: string } | undefined;
if (!row) {
return undefined;
}
return {
token: row.token,
key: row.key,
};
} catch (error) {
logger.error(`Failed to get token from SQLite store`, { error });
return undefined;
}
}
set(tokenKey: string, fullSmapiToken: SmapiToken): void {
try {
const stmt = this.db.prepare(`
INSERT OR REPLACE INTO smapi_tokens (token_key, token, key)
VALUES (?, ?, ?)
`);
stmt.run(tokenKey, fullSmapiToken.token, fullSmapiToken.key);
logger.debug(`Saved token to SQLite store`);
} catch (error) {
logger.error(`Failed to save token to SQLite store`, { error });
}
}
delete(tokenKey: string): void {
try {
const stmt = this.db.prepare("DELETE FROM smapi_tokens WHERE token_key = ?");
stmt.run(tokenKey);
logger.debug(`Deleted token from SQLite store`);
} catch (error) {
logger.error(`Failed to delete token from SQLite store`, { error });
}
}
getAll(): { [tokenKey: string]: SmapiToken } {
try {
const stmt = this.db.prepare("SELECT token_key, token, key FROM smapi_tokens");
const rows = stmt.all() as Array<{ token_key: string; token: string; key: string }>;
const tokens: { [tokenKey: string]: SmapiToken } = {};
for (const row of rows) {
tokens[row.token_key] = {
token: row.token,
key: row.key,
};
}
return tokens;
} catch (error) {
logger.error(`Failed to get all tokens from SQLite store`, { error });
return {};
}
}
cleanupExpired(smapiAuthTokens: SmapiAuthTokens): number {
try {
const tokens = this.getAll();
const tokenKeys = Object.keys(tokens);
let deletedCount = 0;
for (const tokenKey of tokenKeys) {
const smapiToken = tokens[tokenKey];
if (smapiToken) {
const verifyResult = smapiAuthTokens.verify(smapiToken);
// Only delete if token verification fails with InvalidTokenError
// Do NOT delete ExpiredTokenError as those can still be refreshed
if (E.isLeft(verifyResult)) {
const error = verifyResult.left;
// Only delete invalid tokens, not expired ones (which can be refreshed)
if (error._tag === 'InvalidTokenError') {
logger.debug(`Deleting invalid token from SQLite store`);
this.delete(tokenKey);
deletedCount++;
}
}
}
}
if (deletedCount > 0) {
logger.info(`Cleaned up ${deletedCount} invalid token(s) from SQLite store`);
}
return deletedCount;
} catch (error) {
logger.error(`Failed to cleanup expired tokens from SQLite store`, { error });
return 0;
}
}
/**
* Migrate tokens from a JSON file to the SQLite database
* @param jsonFilePath Path to the JSON file containing tokens
* @returns Number of tokens migrated
*/
migrateFromJSON(jsonFilePath: string): number {
try {
if (!fs.existsSync(jsonFilePath)) {
logger.info(`No JSON token file found at ${jsonFilePath}, skipping migration`);
return 0;
}
const data = fs.readFileSync(jsonFilePath, "utf8");
const tokens: { [tokenKey: string]: SmapiToken } = JSON.parse(data);
const tokenKeys = Object.keys(tokens);
let migratedCount = 0;
for (const tokenKey of tokenKeys) {
const token = tokens[tokenKey];
if (token) {
this.set(tokenKey, token);
migratedCount++;
}
}
logger.info(`Migrated ${migratedCount} token(s) from ${jsonFilePath} to SQLite`);
// Optionally rename the old JSON file to .bak
const backupPath = `${jsonFilePath}.bak`;
fs.renameSync(jsonFilePath, backupPath);
logger.info(`Backed up original JSON file to ${backupPath}`);
return migratedCount;
} catch (error) {
logger.error(`Failed to migrate tokens from JSON file ${jsonFilePath}`, { error });
return 0;
}
}
/**
* Close the database connection
*/
close(): void {
try {
this.db.close();
logger.info("SQLite token store connection closed");
} catch (error) {
logger.error("Failed to close SQLite token store connection", { error });
}
}
}

File diff suppressed because it is too large Load Diff

View File

@@ -1,7 +1,34 @@
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++) {
result.push(things[i % things.length]) result.push(things[i % things.length])
} }
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

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

View File

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

View File

@@ -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", "da-DK", "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

@@ -161,6 +161,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

@@ -94,7 +94,7 @@ class SonosDriver {
.get(this.bonobUrl.append({ pathname: "/" }).pathname()) .get(this.bonobUrl.append({ pathname: "/" }).pathname())
.expect(200) .expect(200)
.then((response) => { .then((response) => {
const m = response.text.match(/ action="(.*)" /i); const m = response.text.match(/ action="([^"]+)"/i);
return m![1]!; return m![1]!;
}); });

View File

@@ -2,9 +2,7 @@ import { v4 as uuid } from "uuid";
import dayjs from "dayjs"; import dayjs from "dayjs";
import request from "supertest"; import request from "supertest";
import Image from "image-js"; import Image from "image-js";
import fs from "fs";
import { either as E, taskEither as TE } from "fp-ts"; import { either as E, taskEither as TE } from "fp-ts";
import path from "path";
import { AuthFailure, MusicService } from "../src/music_service"; import { AuthFailure, MusicService } from "../src/music_service";
import makeServer, { import makeServer, {
@@ -242,7 +240,7 @@ describe("server", () => {
.send(); .send();
expect(res.status).toEqual(200); expect(res.status).toEqual(200);
expect(res.text).toMatch(`<h2>${lang("devices")} \(0\)</h2>`); expect(res.text).toMatch(new RegExp(`${lang("devices")}.*\\(0\\)`));
expect(res.text).not.toMatch(/class=device/); expect(res.text).not.toMatch(/class=device/);
expect(res.text).toContain(lang("noSonosDevices")); expect(res.text).toContain(lang("noSonosDevices"));
}); });
@@ -278,7 +276,7 @@ describe("server", () => {
.send(); .send();
expect(res.status).toEqual(200); expect(res.status).toEqual(200);
expect(res.text).toMatch(`<h2>${lang("devices")} \(0\)</h2>`); expect(res.text).toMatch(new RegExp(`${lang("devices")}.*\\(0\\)`));
expect(res.text).not.toMatch(/class=device/); expect(res.text).not.toMatch(/class=device/);
expect(res.text).toContain(lang("noSonosDevices")); expect(res.text).toContain(lang("noSonosDevices"));
}); });
@@ -292,7 +290,7 @@ describe("server", () => {
.send(); .send();
expect(res.status).toEqual(200); expect(res.status).toEqual(200);
expect(res.text).toMatch(`<h2>${lang("services")} \(0\)</h2>`); expect(res.text).toMatch(new RegExp(`${lang("services")}.*\\(0\\)`));
}); });
}); });
}); });
@@ -354,9 +352,9 @@ describe("server", () => {
.send(); .send();
expect(res.status).toEqual(200); expect(res.status).toEqual(200);
expect(res.text).toMatch(`<h2>${lang("devices")} \(2\)</h2>`); expect(res.text).toMatch(new RegExp(`${lang("devices")}.*\\(2\\)`));
expect(res.text).toMatch(/device1\s+\(172.0.0.1:4301\)/); expect(res.text).toMatch(/device1.*172\.0\.0\.1:4301/);
expect(res.text).toMatch(/device2\s+\(172.0.0.2:4302\)/); expect(res.text).toMatch(/device2.*172\.0\.0\.2:4302/);
}); });
}); });
@@ -368,11 +366,11 @@ describe("server", () => {
.send(); .send();
expect(res.status).toEqual(200); expect(res.status).toEqual(200);
expect(res.text).toMatch(`<h2>${lang("services")} \(4\)</h2>`); expect(res.text).toMatch(new RegExp(`${lang("services")}.*\\(4\\)`));
expect(res.text).toMatch(/s1\s+\(1\)/); expect(res.text).toMatch(/s1.*SID:\s*1/);
expect(res.text).toMatch(/s2\s+\(2\)/); expect(res.text).toMatch(/s2.*SID:\s*2/);
expect(res.text).toMatch(/s3\s+\(3\)/); expect(res.text).toMatch(/s3.*SID:\s*3/);
expect(res.text).toMatch(/s4\s+\(4\)/); expect(res.text).toMatch(/s4.*SID:\s*4/);
}); });
}); });
@@ -384,14 +382,11 @@ describe("server", () => {
.send(); .send();
expect(res.status).toEqual(200); expect(res.status).toEqual(200);
expect(res.text).toMatch( expect(res.text).toMatch(
`<input type="submit" value="${lang("register")}">` `<input type="submit" value="${lang("register")}" id="submit">`
);
expect(res.text).toMatch(`<h3>${lang("expectedConfig")}</h3>`);
expect(res.text).toMatch(
`<h3>${lang("noExistingServiceRegistration")}</h3>`
); );
expect(res.text).toContain(lang("noExistingServiceRegistration"));
expect(res.text).not.toMatch( expect(res.text).not.toMatch(
`<input type="submit" value="${lang("removeRegistration")}">` `value="${lang("removeRegistration")}"`
); );
}); });
}); });
@@ -442,14 +437,11 @@ describe("server", () => {
.send(); .send();
expect(res.status).toEqual(200); expect(res.status).toEqual(200);
expect(res.text).toMatch( expect(res.text).toMatch(
`<input type="submit" value="${lang("register")}">` `<input type="submit" value="${lang("register")}" id="submit">`
); );
expect(res.text).toMatch(`<h3>${lang("expectedConfig")}</h3>`); expect(res.text).toContain(lang("existingServiceConfig"));
expect(res.text).toMatch( expect(res.text).toMatch(
`<h3>${lang("existingServiceConfig")}</h3>` `<input type="submit" value="${lang("removeRegistration")}" id="submit"`
);
expect(res.text).toMatch(
`<input type="submit" value="${lang("removeRegistration")}">`
); );
}); });
}); });
@@ -634,13 +626,13 @@ describe("server", () => {
expect(res.status).toEqual(200); expect(res.status).toEqual(200);
expect(res.text).toMatch(`<title>${lang("login")}</title>`); expect(res.text).toMatch(`<title>${lang("login")}</title>`);
expect(res.text).toMatch( expect(res.text).toMatch(
`<h1 class="login one-word-per-line">${lang("logInToBonob")}</h1>` `<h1>${lang("logInToBonob")}</h1>`
); );
expect(res.text).toMatch( expect(res.text).toMatch(
`<label for="username">${lang("username")}:</label>` `<label for="username">${lang("username")}</label>`
); );
expect(res.text).toMatch( expect(res.text).toMatch(
`<label for="password">${lang("password")}:</label>` `<label for="password">${lang("password")}</label>`
); );
expect(res.text).toMatch( expect(res.text).toMatch(
`<input type="submit" value="${lang("login")}" id="submit">` `<input type="submit" value="${lang("login")}" id="submit">`
@@ -755,15 +747,22 @@ describe("server", () => {
const trackId = `t-${uuid()}`; const trackId = `t-${uuid()}`;
const smapiAuthToken: SmapiToken = { token: `token-${uuid()}`, key: `key-${uuid()}` }; const smapiAuthToken: SmapiToken = { token: `token-${uuid()}`, key: `key-${uuid()}` };
const streamContent = (content: string) => ({ const streamContent = (content: string) => {
pipe: (_: Transform) => { const self = {
return { destroyed: false,
pipe: (res: Response) => { pipe: (_: Transform) => {
res.send(content); return {
}, pipe: (res: Response) => {
}; res.send(content);
}, }
}); };
},
destroy: () => {
self.destroyed = true;
}
};
return self;
};
describe("HEAD requests", () => { describe("HEAD requests", () => {
describe("when there is no Bearer token", () => { describe("when there is no Bearer token", () => {
@@ -829,6 +828,8 @@ describe("server", () => {
); );
expect(res.headers["content-length"]).toEqual("123"); expect(res.headers["content-length"]).toEqual("123");
expect(res.body).toEqual({}); expect(res.body).toEqual({});
expect(trackStream.stream.destroyed).toBe(true);
}); });
}); });
@@ -854,6 +855,8 @@ describe("server", () => {
expect(res.status).toEqual(404); expect(res.status).toEqual(404);
expect(res.body).toEqual({}); expect(res.body).toEqual({});
expect(trackStream.stream.destroyed).toBe(true);
}); });
}); });
}); });
@@ -916,6 +919,8 @@ describe("server", () => {
expect(musicLibrary.nowPlaying).not.toHaveBeenCalled(); expect(musicLibrary.nowPlaying).not.toHaveBeenCalled();
expect(musicLibrary.stream).toHaveBeenCalledWith({ trackId }); expect(musicLibrary.stream).toHaveBeenCalledWith({ trackId });
expect(stream.stream.destroyed).toBe(true);
}); });
}); });
@@ -959,6 +964,8 @@ describe("server", () => {
expect(musicService.login).toHaveBeenCalledWith(serviceToken); expect(musicService.login).toHaveBeenCalledWith(serviceToken);
expect(musicLibrary.nowPlaying).toHaveBeenCalledWith(trackId); expect(musicLibrary.nowPlaying).toHaveBeenCalledWith(trackId);
expect(musicLibrary.stream).toHaveBeenCalledWith({ trackId }); expect(musicLibrary.stream).toHaveBeenCalledWith({ trackId });
expect(stream.stream.destroyed).toBe(true);
}); });
}); });
@@ -1000,6 +1007,8 @@ describe("server", () => {
expect(musicService.login).toHaveBeenCalledWith(serviceToken); expect(musicService.login).toHaveBeenCalledWith(serviceToken);
expect(musicLibrary.nowPlaying).toHaveBeenCalledWith(trackId); expect(musicLibrary.nowPlaying).toHaveBeenCalledWith(trackId);
expect(musicLibrary.stream).toHaveBeenCalledWith({ trackId }); expect(musicLibrary.stream).toHaveBeenCalledWith({ trackId });
expect(stream.stream.destroyed).toBe(true);
}); });
}); });
@@ -1040,6 +1049,8 @@ describe("server", () => {
expect(musicService.login).toHaveBeenCalledWith(serviceToken); expect(musicService.login).toHaveBeenCalledWith(serviceToken);
expect(musicLibrary.nowPlaying).toHaveBeenCalledWith(trackId); expect(musicLibrary.nowPlaying).toHaveBeenCalledWith(trackId);
expect(musicLibrary.stream).toHaveBeenCalledWith({ trackId }); expect(musicLibrary.stream).toHaveBeenCalledWith({ trackId });
expect(stream.stream.destroyed).toBe(true);
}); });
}); });
@@ -1083,6 +1094,8 @@ describe("server", () => {
expect(musicService.login).toHaveBeenCalledWith(serviceToken); expect(musicService.login).toHaveBeenCalledWith(serviceToken);
expect(musicLibrary.nowPlaying).toHaveBeenCalledWith(trackId); expect(musicLibrary.nowPlaying).toHaveBeenCalledWith(trackId);
expect(musicLibrary.stream).toHaveBeenCalledWith({ trackId }); expect(musicLibrary.stream).toHaveBeenCalledWith({ trackId });
expect(stream.stream.destroyed).toBe(true);
}); });
}); });
}); });
@@ -1131,6 +1144,8 @@ describe("server", () => {
trackId, trackId,
range: requestedRange, range: requestedRange,
}); });
expect(stream.stream.destroyed).toBe(true);
}); });
}); });
@@ -1178,6 +1193,8 @@ describe("server", () => {
trackId, trackId,
range: "4000-5000", range: "4000-5000",
}); });
expect(stream.stream.destroyed).toBe(true);
}); });
}); });
}); });
@@ -1298,279 +1315,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);
@@ -1616,11 +1360,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 () => {
@@ -1648,6 +1406,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",
@@ -1777,6 +1549,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>`
);
});
});
});
}); });
}); });
}); });

View File

@@ -18,14 +18,13 @@ import {
track, track,
artist, artist,
album, album,
defaultAlbumArtURI, coverArtURI,
defaultArtistArtURI,
searchResult, searchResult,
iconArtURI, iconArtURI,
playlistAlbumArtURL,
sonosifyMimeType, sonosifyMimeType,
ratingAsInt, ratingAsInt,
ratingFromInt, ratingFromInt,
internetRadioStation
} from "../src/smapi"; } from "../src/smapi";
import { keys as i8nKeys } from "../src/i8n"; import { keys as i8nKeys } from "../src/i8n";
@@ -41,7 +40,7 @@ import {
TRIP_HOP, TRIP_HOP,
PUNK, PUNK,
aPlaylist, aPlaylist,
anAlbumSummary, aRadioStation,
} from "./builders"; } from "./builders";
import { InMemoryMusicService } from "./in_memory_music_service"; import { InMemoryMusicService } from "./in_memory_music_service";
import supersoap from "./supersoap"; import supersoap from "./supersoap";
@@ -56,7 +55,6 @@ import dayjs from "dayjs";
import url, { URLBuilder } from "../src/url_builder"; import url, { URLBuilder } from "../src/url_builder";
import { iconForGenre } from "../src/icon"; import { iconForGenre } from "../src/icon";
import { formatForURL } from "../src/burn"; import { formatForURL } from "../src/burn";
import { range } from "underscore";
import { FixedClock } from "../src/clock"; import { FixedClock } from "../src/clock";
import { ExpiredTokenError, InvalidTokenError, SmapiAuthTokens, SmapiToken, ToSmapiFault } from "../src/smapi_auth"; import { ExpiredTokenError, InvalidTokenError, SmapiAuthTokens, SmapiToken, ToSmapiFault } from "../src/smapi_auth";
@@ -135,8 +133,8 @@ describe("service config", () => {
"Sonos koppelen aan music land" "Sonos koppelen aan music land"
); );
// no fr-FR translation, so use en-US // no pt-BR translation, so use en-US
expect(sonosString("AppLinkMessage", "fr-FR")).toEqual( expect(sonosString("AppLinkMessage", "pt-BR")).toEqual(
"Linking sonos with music land" "Linking sonos with music land"
); );
}); });
@@ -356,7 +354,10 @@ describe("track", () => {
const someTrack = aTrack({ const someTrack = aTrack({
id: uuid(), id: uuid(),
// audio/x-flac should be mapped to audio/flac // audio/x-flac should be mapped to audio/flac
mimeType: "audio/x-flac", encoding: {
player: "something",
mimeType: "audio/x-flac"
},
name: "great song", name: "great song",
duration: randomInt(1000), duration: randomInt(1000),
number: randomInt(100), number: randomInt(100),
@@ -411,7 +412,10 @@ describe("track", () => {
const someTrack = aTrack({ const someTrack = aTrack({
id: uuid(), id: uuid(),
// audio/x-flac should be mapped to audio/flac // audio/x-flac should be mapped to audio/flac
mimeType: "audio/x-flac", encoding: {
player: "something",
mimeType: "audio/x-flac"
},
name: "great song", name: "great song",
duration: randomInt(1000), duration: randomInt(1000),
number: randomInt(100), number: randomInt(100),
@@ -471,7 +475,7 @@ describe("album", () => {
itemType: "album", itemType: "album",
id: `album:${someAlbum.id}`, id: `album:${someAlbum.id}`,
title: someAlbum.name, title: someAlbum.name,
albumArtURI: defaultAlbumArtURI(bonobUrl, someAlbum).href(), albumArtURI: coverArtURI(bonobUrl, someAlbum).href(),
canPlay: true, canPlay: true,
artist: someAlbum.artistName, artist: someAlbum.artistName,
artistId: `artist:${someAlbum.artistId}`, artistId: `artist:${someAlbum.artistId}`,
@@ -479,6 +483,18 @@ describe("album", () => {
}); });
}); });
describe("internetRadioStation", () => {
it("should map to a sonos internet stream", () => {
const station = aRadioStation()
expect(internetRadioStation(station)).toEqual({
itemType: "stream",
id: `internetRadioStation:${station.id}`,
title: station.name,
mimeType: "audio/mpeg"
})
});
});
describe("sonosifyMimeType", () => { describe("sonosifyMimeType", () => {
describe("when is audio/x-flac", () => { describe("when is audio/x-flac", () => {
it("should be mapped to audio/flac", () => { it("should be mapped to audio/flac", () => {
@@ -495,279 +511,8 @@ describe("sonosifyMimeType", () => {
}); });
}); });
describe("playlistAlbumArtURL", () => {
const coverArt1 = { system: "subsonic", resource: "1" };
const coverArt2 = { system: "subsonic", resource: "2" };
const coverArt3 = { system: "subsonic", resource: "3" };
const coverArt4 = { system: "subsonic", resource: "4" };
const coverArt5 = { system: "subsonic", resource: "5" };
describe("when the playlist has no coverArt ids", () => { describe("coverArtURI", () => {
it("should return question mark icon", () => {
const bonobUrl = url("http://localhost:1234/context-path?search=yes");
const playlist = aPlaylist({
entries: [
aTrack({ coverArt: undefined }),
aTrack({ coverArt: undefined }),
],
});
expect(playlistAlbumArtURL(bonobUrl, playlist).href()).toEqual(
`http://localhost:1234/context-path/icon/error/size/legacy?search=yes`
);
});
});
describe("when the playlist has external ids", () => {
it("should format the url with encrypted urn", () => {
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" }),
}),
],
});
expect(playlistAlbumArtURL(bonobUrl, playlist).href()).toEqual(
`http://localhost:1234/context-path/art/${encodeURIComponent(
formatForURL(externalArt1)
)}&${encodeURIComponent(
formatForURL(externalArt2)
)}/size/180?search=yes`
);
});
});
describe("when the playlist has 4 tracks from 2 different albums, including some tracks that are missing coverArt urns", () => {
it("should use the cover art once per album", () => {
const bonobUrl = url("http://localhost:1234/context-path?search=yes");
const playlist = aPlaylist({
entries: [
aTrack({
coverArt: undefined,
album: anAlbumSummary({ id: "album1" }),
}),
aTrack({
coverArt: coverArt1,
album: anAlbumSummary({ id: "album1" }),
}),
aTrack({
coverArt: coverArt2,
album: anAlbumSummary({ id: "album2" }),
}),
aTrack({
coverArt: undefined,
album: anAlbumSummary({ id: "album2" }),
}),
aTrack({
coverArt: coverArt3,
album: anAlbumSummary({ id: "album1" }),
}),
aTrack({
coverArt: coverArt4,
album: anAlbumSummary({ id: "album2" }),
}),
aTrack({
coverArt: undefined,
album: anAlbumSummary({ id: "album2" }),
}),
],
});
expect(playlistAlbumArtURL(bonobUrl, playlist).href()).toEqual(
`http://localhost:1234/context-path/art/${encodeURIComponent(
formatForURL(coverArt1)
)}&${encodeURIComponent(formatForURL(coverArt2))}/size/180?search=yes`
);
});
});
describe("when the playlist has 4 tracks from 2 different albums", () => {
it("should use the cover art once per album", () => {
const bonobUrl = url("http://localhost:1234/context-path?search=yes");
const playlist = aPlaylist({
entries: [
aTrack({
coverArt: coverArt1,
album: anAlbumSummary({ id: "album1" }),
}),
aTrack({
coverArt: coverArt2,
album: anAlbumSummary({ id: "album2" }),
}),
aTrack({
coverArt: coverArt3,
album: anAlbumSummary({ id: "album1" }),
}),
aTrack({
coverArt: coverArt4,
album: anAlbumSummary({ id: "album2" }),
}),
],
});
expect(playlistAlbumArtURL(bonobUrl, playlist).href()).toEqual(
`http://localhost:1234/context-path/art/${encodeURIComponent(
formatForURL(coverArt1)
)}&${encodeURIComponent(formatForURL(coverArt2))}/size/180?search=yes`
);
});
});
describe("when the playlist has 4 tracks from 3 different albums", () => {
it("should use the cover art once per album", () => {
const bonobUrl = url("http://localhost:1234/context-path?search=yes");
const playlist = aPlaylist({
entries: [
aTrack({
coverArt: coverArt1,
album: anAlbumSummary({ id: "album1" }),
}),
aTrack({
coverArt: coverArt2,
album: anAlbumSummary({ id: "album2" }),
}),
aTrack({
coverArt: coverArt3,
album: anAlbumSummary({ id: "album1" }),
}),
aTrack({
coverArt: coverArt4,
album: anAlbumSummary({ id: "album3" }),
}),
],
});
expect(playlistAlbumArtURL(bonobUrl, playlist).href()).toEqual(
`http://localhost:1234/context-path/art/${encodeURIComponent(
formatForURL(coverArt1)
)}&${encodeURIComponent(formatForURL(coverArt2))}&${encodeURIComponent(
formatForURL(coverArt4)
)}/size/180?search=yes`
);
});
});
describe("when the playlist has 4 tracks from 4 different albums", () => {
it("should return them on the url to the image", () => {
const bonobUrl = url("http://localhost:1234/context-path?search=yes");
const playlist = aPlaylist({
entries: [
aTrack({
coverArt: coverArt1,
album: anAlbumSummary({ id: "album1" }),
}),
aTrack({
coverArt: coverArt2,
album: anAlbumSummary({ id: "album2" }),
}),
aTrack({
coverArt: coverArt3,
album: anAlbumSummary({ id: "album3" }),
}),
aTrack({
coverArt: coverArt4,
album: anAlbumSummary({ id: "album4" }),
}),
aTrack({
coverArt: coverArt5,
album: anAlbumSummary({ id: "album1" }),
}),
],
});
expect(playlistAlbumArtURL(bonobUrl, playlist).href()).toEqual(
`http://localhost:1234/context-path/art/${encodeURIComponent(
formatForURL(coverArt1)
)}&${encodeURIComponent(formatForURL(coverArt2))}&${encodeURIComponent(
formatForURL(coverArt3)
)}&${encodeURIComponent(formatForURL(coverArt4))}/size/180?search=yes`
);
});
});
describe("when the playlist has at least 9 distinct albumIds", () => {
it("should return the first 9 of the ids on the url", () => {
const bonobUrl = url("http://localhost:1234/context-path?search=yes");
const playlist = aPlaylist({
entries: [
aTrack({
coverArt: { system: "subsonic", resource: "1" },
album: anAlbumSummary({ id: "1" }),
}),
aTrack({
coverArt: { system: "subsonic", resource: "2" },
album: anAlbumSummary({ id: "2" }),
}),
aTrack({
coverArt: { system: "subsonic", resource: "3" },
album: anAlbumSummary({ id: "3" }),
}),
aTrack({
coverArt: { system: "subsonic", resource: "4" },
album: anAlbumSummary({ id: "4" }),
}),
aTrack({
coverArt: { system: "subsonic", resource: "5" },
album: anAlbumSummary({ id: "5" }),
}),
aTrack({
coverArt: { system: "subsonic", resource: "6" },
album: anAlbumSummary({ id: "6" }),
}),
aTrack({
coverArt: { system: "subsonic", resource: "7" },
album: anAlbumSummary({ id: "7" }),
}),
aTrack({
coverArt: { system: "subsonic", resource: "8" },
album: anAlbumSummary({ id: "8" }),
}),
aTrack({
coverArt: { system: "subsonic", resource: "9" },
album: anAlbumSummary({ id: "9" }),
}),
aTrack({
coverArt: { system: "subsonic", resource: "10" },
album: anAlbumSummary({ id: "10" }),
}),
aTrack({
coverArt: { system: "subsonic", resource: "11" },
album: anAlbumSummary({ id: "11" }),
}),
],
});
const burns = range(1, 10)
.map((i) =>
encodeURIComponent(
formatForURL({ system: "subsonic", resource: `${i}` })
)
)
.join("&");
expect(playlistAlbumArtURL(bonobUrl, playlist).href()).toEqual(
`http://localhost:1234/context-path/art/${burns}/size/180?search=yes`
);
});
});
});
describe("defaultAlbumArtURI", () => {
const bonobUrl = new URLBuilder( const bonobUrl = new URLBuilder(
"http://bonob.example.com:8080/context?search=yes" "http://bonob.example.com:8080/context?search=yes"
); );
@@ -777,7 +522,7 @@ describe("defaultAlbumArtURI", () => {
it("should use it", () => { it("should use it", () => {
const coverArt = { system: "subsonic", resource: "12345" }; const coverArt = { system: "subsonic", resource: "12345" };
expect( expect(
defaultAlbumArtURI(bonobUrl, anAlbum({ coverArt })).href() coverArtURI(bonobUrl, anAlbum({ coverArt })).href()
).toEqual( ).toEqual(
`http://bonob.example.com:8080/context/art/${encodeURIComponent( `http://bonob.example.com:8080/context/art/${encodeURIComponent(
formatForURL(coverArt) formatForURL(coverArt)
@@ -793,7 +538,7 @@ describe("defaultAlbumArtURI", () => {
resource: "http://example.com/someimage.jpg", resource: "http://example.com/someimage.jpg",
}; };
expect( expect(
defaultAlbumArtURI(bonobUrl, anAlbum({ coverArt })).href() coverArtURI(bonobUrl, anAlbum({ coverArt })).href()
).toEqual( ).toEqual(
`http://bonob.example.com:8080/context/art/${encodeURIComponent( `http://bonob.example.com:8080/context/art/${encodeURIComponent(
formatForURL(coverArt) formatForURL(coverArt)
@@ -806,7 +551,7 @@ describe("defaultAlbumArtURI", () => {
describe("when there is no album coverArt", () => { describe("when there is no album coverArt", () => {
it("should return a vinly icon image", () => { it("should return a vinly icon image", () => {
expect( expect(
defaultAlbumArtURI(bonobUrl, anAlbum({ coverArt: undefined })).href() coverArtURI(bonobUrl, anAlbum({ coverArt: undefined })).href()
).toEqual( ).toEqual(
"http://bonob.example.com:8080/context/icon/vinyl/size/legacy?search=yes" "http://bonob.example.com:8080/context/icon/vinyl/size/legacy?search=yes"
); );
@@ -814,46 +559,20 @@ describe("defaultAlbumArtURI", () => {
}); });
}); });
describe("defaultArtistArtURI", () => { describe("iconArtURI", () => {
describe("when the artist has no image", () => { const bonobUrl = new URLBuilder(
it("should return an icon", () => { "http://bonob.example.com:8080/context?search=yes"
const bonobUrl = url("http://localhost:1234/something?s=123"); );
const artist = anArtist({ image: undefined });
expect(defaultArtistArtURI(bonobUrl, artist).href()).toEqual( describe("with no text", () => {
`http://localhost:1234/something/icon/vinyl/size/legacy?s=123` it("should return just the icon uri", () => {
); expect(iconArtURI(bonobUrl, "mushroom").href()).toEqual("http://bonob.example.com:8080/context/icon/mushroom/size/legacy?search=yes")
}); });
}); });
describe("when the resource is subsonic", () => { describe("with text", () => {
it("should use the resource", () => { it("should return just the icon uri", () => {
const bonobUrl = url("http://localhost:1234/something?s=123"); expect(iconArtURI(bonobUrl, "yyyy", "foobar10000").href()).toEqual("http://bonob.example.com:8080/context/icon/yyyy:foobar10000/size/legacy?search=yes")
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`
);
}); });
}); });
}); });
@@ -874,6 +593,8 @@ describe("wsdl api", () => {
artists: jest.fn(), artists: jest.fn(),
artist: jest.fn(), artist: jest.fn(),
genres: jest.fn(), genres: jest.fn(),
years: jest.fn(),
year: jest.fn(),
playlists: jest.fn(), playlists: jest.fn(),
playlist: jest.fn(), playlist: jest.fn(),
album: jest.fn(), album: jest.fn(),
@@ -890,6 +611,8 @@ describe("wsdl api", () => {
scrobble: jest.fn(), scrobble: jest.fn(),
nowPlaying: jest.fn(), nowPlaying: jest.fn(),
rate: jest.fn(), rate: jest.fn(),
radioStation: jest.fn(),
radioStations: jest.fn(),
}; };
const apiTokens = { const apiTokens = {
mint: jest.fn(), mint: jest.fn(),
@@ -1261,8 +984,8 @@ describe("wsdl api", () => {
}); });
expect(result[0]).toEqual( expect(result[0]).toEqual(
searchResult({ searchResult({
mediaCollection: tracks.map((it) => mediaMetadata: tracks.map((it) =>
album(bonobUrlWithAccessToken, it.album) track(bonobUrlWithAccessToken, it)
), ),
index: 0, index: 0,
total: 2, total: 2,
@@ -1437,7 +1160,8 @@ describe("wsdl api", () => {
id: "playlists", id: "playlists",
title: "Playlists", title: "Playlists",
albumArtURI: iconArtURI(bonobUrl, "playlists").href(), albumArtURI: iconArtURI(bonobUrl, "playlists").href(),
itemType: "playlist", itemType: "container",
canEnumerate: true,
attributes: { attributes: {
readOnly: "false", readOnly: "false",
renameable: "false", renameable: "false",
@@ -1450,6 +1174,12 @@ describe("wsdl api", () => {
albumArtURI: iconArtURI(bonobUrl, "genres").href(), albumArtURI: iconArtURI(bonobUrl, "genres").href(),
itemType: "container", itemType: "container",
}, },
{
id: "years",
title: "Years",
albumArtURI: iconArtURI(bonobUrl, "music").href(),
itemType: "container",
},
{ {
id: "recentlyAdded", id: "recentlyAdded",
title: "Recently added", title: "Recently added",
@@ -1471,6 +1201,12 @@ describe("wsdl api", () => {
albumArtURI: iconArtURI(bonobUrl, "mostPlayed").href(), albumArtURI: iconArtURI(bonobUrl, "mostPlayed").href(),
itemType: "albumList", itemType: "albumList",
}, },
{
id: "internetRadio",
title: "Internet Radio",
albumArtURI: iconArtURI(bonobUrl, "radio").href(),
itemType: "stream",
},
]; ];
expect(root[0]).toEqual( expect(root[0]).toEqual(
getMetadataResult({ getMetadataResult({
@@ -1525,7 +1261,8 @@ describe("wsdl api", () => {
id: "playlists", id: "playlists",
title: "Afspeellijsten", title: "Afspeellijsten",
albumArtURI: iconArtURI(bonobUrl, "playlists").href(), albumArtURI: iconArtURI(bonobUrl, "playlists").href(),
itemType: "playlist", itemType: "container",
canEnumerate: true,
attributes: { attributes: {
readOnly: "false", readOnly: "false",
renameable: "false", renameable: "false",
@@ -1538,6 +1275,12 @@ describe("wsdl api", () => {
albumArtURI: iconArtURI(bonobUrl, "genres").href(), albumArtURI: iconArtURI(bonobUrl, "genres").href(),
itemType: "container", itemType: "container",
}, },
{
id: "years",
title: "Jaren",
albumArtURI: iconArtURI(bonobUrl, "music").href(),
itemType: "container",
},
{ {
id: "recentlyAdded", id: "recentlyAdded",
title: "Onlangs toegevoegd", title: "Onlangs toegevoegd",
@@ -1559,6 +1302,12 @@ describe("wsdl api", () => {
albumArtURI: iconArtURI(bonobUrl, "mostPlayed").href(), albumArtURI: iconArtURI(bonobUrl, "mostPlayed").href(),
itemType: "albumList", itemType: "albumList",
}, },
{
id: "internetRadio",
title: "Internet Radio",
albumArtURI: iconArtURI(bonobUrl, "radio").href(),
itemType: "stream",
},
]; ];
expect(root[0]).toEqual( expect(root[0]).toEqual(
getMetadataResult({ getMetadataResult({
@@ -1609,7 +1358,7 @@ describe("wsdl api", () => {
expect(result[0]).toEqual( expect(result[0]).toEqual(
getMetadataResult({ getMetadataResult({
mediaCollection: expectedGenres.map((genre) => ({ mediaCollection: expectedGenres.map((genre) => ({
itemType: "container", itemType: "albumList",
id: `genre:${genre.id}`, id: `genre:${genre.id}`,
title: genre.name, title: genre.name,
albumArtURI: iconArtURI( albumArtURI: iconArtURI(
@@ -1634,7 +1383,7 @@ describe("wsdl api", () => {
expect(result[0]).toEqual( expect(result[0]).toEqual(
getMetadataResult({ getMetadataResult({
mediaCollection: [PUNK, ROCK].map((genre) => ({ mediaCollection: [PUNK, ROCK].map((genre) => ({
itemType: "container", itemType: "albumList",
id: `genre:${genre.id}`, id: `genre:${genre.id}`,
title: genre.name, title: genre.name,
albumArtURI: iconArtURI( albumArtURI: iconArtURI(
@@ -1650,11 +1399,75 @@ describe("wsdl api", () => {
}); });
}); });
describe("asking for a year", () => {
const expectedYears = [{ year: "?" }, { year: "1969" }, { year: "1980" }, { year: "2001" }, { year: "2010" }];
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,
});
const albumListForYear = (year: string, icon: URLBuilder) => ({
itemType: "albumList",
id: `year:${year}`,
title: year,
albumArtURI: icon.href(),
});
expect(result[0]).toEqual(
getMetadataResult({
mediaCollection: [
albumListForYear("?", iconArtURI(bonobUrl, "music")),
albumListForYear("1969", iconArtURI(bonobUrl, "yyyy", "1969")),
albumListForYear("1980", iconArtURI(bonobUrl, "yyyy", "1980")),
albumListForYear("2001", iconArtURI(bonobUrl, "yyyy", "2001")),
albumListForYear("2010", iconArtURI(bonobUrl, "yyyy", "2010")),
],
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: 2,
count: 2,
});
expect(result[0]).toEqual(
getMetadataResult({
mediaCollection: [{ year: "1980" }, { year: "2001" }].map((year) => ({
itemType: "albumList",
id: `year:${year.year}`,
title: year.year,
albumArtURI: iconArtURI(
bonobUrl,
"yyyy",
year.year
).href(),
})),
index: 2,
total: expectedYears.length,
})
);
});
});
});
describe("asking for playlists", () => { describe("asking for playlists", () => {
const playlist1 = aPlaylist({ id: "1", name: "pl1" }); const playlist1 = aPlaylist({ id: "1", name: "pl1", entries: []});
const playlist2 = aPlaylist({ id: "2", name: "pl2" }); const playlist2 = aPlaylist({ id: "2", name: "pl2", entries: []});
const playlist3 = aPlaylist({ id: "3", name: "pl3" }); const playlist3 = aPlaylist({ id: "3", name: "pl3", entries: []});
const playlist4 = aPlaylist({ id: "4", name: "pl4" }); const playlist4 = aPlaylist({ id: "4", name: "pl4", entries: []});
const playlists = [playlist1, playlist2, playlist3, playlist4]; const playlists = [playlist1, playlist2, playlist3, playlist4];
@@ -1681,11 +1494,12 @@ describe("wsdl api", () => {
itemType: "playlist", itemType: "playlist",
id: `playlist:${playlist.id}`, id: `playlist:${playlist.id}`,
title: playlist.name, title: playlist.name,
albumArtURI: playlistAlbumArtURL( albumArtURI: coverArtURI(
bonobUrlWithAccessToken, bonobUrlWithAccessToken,
playlist playlist
).href(), ).href(),
canPlay: true, canPlay: true,
canEnumerate: true,
attributes: { attributes: {
readOnly: "false", readOnly: "false",
userContent: "false", userContent: "false",
@@ -1713,11 +1527,12 @@ describe("wsdl api", () => {
itemType: "playlist", itemType: "playlist",
id: `playlist:${playlist.id}`, id: `playlist:${playlist.id}`,
title: playlist.name, title: playlist.name,
albumArtURI: playlistAlbumArtURL( albumArtURI: coverArtURI(
bonobUrlWithAccessToken, bonobUrlWithAccessToken,
playlist playlist
).href(), ).href(),
canPlay: true, canPlay: true,
canEnumerate: true,
attributes: { attributes: {
readOnly: "false", readOnly: "false",
userContent: "false", userContent: "false",
@@ -1757,7 +1572,7 @@ describe("wsdl api", () => {
itemType: "album", itemType: "album",
id: `album:${it.id}`, id: `album:${it.id}`,
title: it.name, title: it.name,
albumArtURI: defaultAlbumArtURI( albumArtURI: coverArtURI(
bonobUrlWithAccessToken, bonobUrlWithAccessToken,
it it
).href(), ).href(),
@@ -1794,7 +1609,7 @@ describe("wsdl api", () => {
itemType: "album", itemType: "album",
id: `album:${it.id}`, id: `album:${it.id}`,
title: it.name, title: it.name,
albumArtURI: defaultAlbumArtURI( albumArtURI: coverArtURI(
bonobUrlWithAccessToken, bonobUrlWithAccessToken,
it it
).href(), ).href(),
@@ -1846,9 +1661,9 @@ describe("wsdl api", () => {
id: `artist:${it.id}`, id: `artist:${it.id}`,
artistId: it.id, artistId: it.id,
title: it.name, title: it.name,
albumArtURI: defaultArtistArtURI( albumArtURI: coverArtURI(
bonobUrlWithAccessToken, bonobUrlWithAccessToken,
it { coverArt: it.image }
).href(), ).href(),
})), })),
index: 0, index: 0,
@@ -1891,9 +1706,9 @@ describe("wsdl api", () => {
id: `artist:${it.id}`, id: `artist:${it.id}`,
artistId: it.id, artistId: it.id,
title: it.name, title: it.name,
albumArtURI: defaultArtistArtURI( albumArtURI: coverArtURI(
bonobUrlWithAccessToken, bonobUrlWithAccessToken,
it { coverArt: it.image }
).href(), ).href(),
})), })),
index: 1, index: 1,
@@ -1952,9 +1767,9 @@ describe("wsdl api", () => {
id: `artist:${it.id}`, id: `artist:${it.id}`,
artistId: it.id, artistId: it.id,
title: it.name, title: it.name,
albumArtURI: defaultArtistArtURI( albumArtURI: coverArtURI(
bonobUrlWithAccessToken, bonobUrlWithAccessToken,
it { coverArt: it.image }
).href(), ).href(),
})), })),
index: 0, index: 0,
@@ -1981,9 +1796,9 @@ describe("wsdl api", () => {
id: `artist:${it.id}`, id: `artist:${it.id}`,
artistId: it.id, artistId: it.id,
title: it.name, title: it.name,
albumArtURI: defaultArtistArtURI( albumArtURI: coverArtURI(
bonobUrlWithAccessToken, bonobUrlWithAccessToken,
it { coverArt: it.image }
).href(), ).href(),
}) })
), ),
@@ -2098,7 +1913,7 @@ describe("wsdl api", () => {
itemType: "album", itemType: "album",
id: `album:${it.id}`, id: `album:${it.id}`,
title: it.name, title: it.name,
albumArtURI: defaultAlbumArtURI( albumArtURI: coverArtURI(
bonobUrlWithAccessToken, bonobUrlWithAccessToken,
it it
).href(), ).href(),
@@ -2146,7 +1961,7 @@ describe("wsdl api", () => {
itemType: "album", itemType: "album",
id: `album:${it.id}`, id: `album:${it.id}`,
title: it.name, title: it.name,
albumArtURI: defaultAlbumArtURI( albumArtURI: coverArtURI(
bonobUrlWithAccessToken, bonobUrlWithAccessToken,
it it
).href(), ).href(),
@@ -2194,7 +2009,7 @@ describe("wsdl api", () => {
itemType: "album", itemType: "album",
id: `album:${it.id}`, id: `album:${it.id}`,
title: it.name, title: it.name,
albumArtURI: defaultAlbumArtURI( albumArtURI: coverArtURI(
bonobUrlWithAccessToken, bonobUrlWithAccessToken,
it it
).href(), ).href(),
@@ -2242,7 +2057,7 @@ describe("wsdl api", () => {
itemType: "album", itemType: "album",
id: `album:${it.id}`, id: `album:${it.id}`,
title: it.name, title: it.name,
albumArtURI: defaultAlbumArtURI( albumArtURI: coverArtURI(
bonobUrlWithAccessToken, bonobUrlWithAccessToken,
it it
).href(), ).href(),
@@ -2290,7 +2105,7 @@ describe("wsdl api", () => {
itemType: "album", itemType: "album",
id: `album:${it.id}`, id: `album:${it.id}`,
title: it.name, title: it.name,
albumArtURI: defaultAlbumArtURI( albumArtURI: coverArtURI(
bonobUrlWithAccessToken, bonobUrlWithAccessToken,
it it
).href(), ).href(),
@@ -2338,7 +2153,7 @@ describe("wsdl api", () => {
itemType: "album", itemType: "album",
id: `album:${it.id}`, id: `album:${it.id}`,
title: it.name, title: it.name,
albumArtURI: defaultAlbumArtURI( albumArtURI: coverArtURI(
bonobUrlWithAccessToken, bonobUrlWithAccessToken,
it it
).href(), ).href(),
@@ -2384,7 +2199,7 @@ describe("wsdl api", () => {
itemType: "album", itemType: "album",
id: `album:${it.id}`, id: `album:${it.id}`,
title: it.name, title: it.name,
albumArtURI: defaultAlbumArtURI( albumArtURI: coverArtURI(
bonobUrlWithAccessToken, bonobUrlWithAccessToken,
it it
).href(), ).href(),
@@ -2430,7 +2245,7 @@ describe("wsdl api", () => {
itemType: "album", itemType: "album",
id: `album:${it.id}`, id: `album:${it.id}`,
title: it.name, title: it.name,
albumArtURI: defaultAlbumArtURI( albumArtURI: coverArtURI(
bonobUrlWithAccessToken, bonobUrlWithAccessToken,
it it
).href(), ).href(),
@@ -2474,7 +2289,7 @@ describe("wsdl api", () => {
itemType: "album", itemType: "album",
id: `album:${it.id}`, id: `album:${it.id}`,
title: it.name, title: it.name,
albumArtURI: defaultAlbumArtURI( albumArtURI: coverArtURI(
bonobUrlWithAccessToken, bonobUrlWithAccessToken,
it it
).href(), ).href(),
@@ -2521,7 +2336,7 @@ describe("wsdl api", () => {
itemType: "album", itemType: "album",
id: `album:${it.id}`, id: `album:${it.id}`,
title: it.name, title: it.name,
albumArtURI: defaultAlbumArtURI( albumArtURI: coverArtURI(
bonobUrlWithAccessToken, bonobUrlWithAccessToken,
it it
).href(), ).href(),
@@ -2688,6 +2503,71 @@ describe("wsdl api", () => {
}); });
}); });
}); });
describe("asking for internet radio stations", () => {
const station1 = aRadioStation();
const station2 = aRadioStation();
const station3 = aRadioStation();
const station4 = aRadioStation();
const stations = [station1, station2, station3, station4];
beforeEach(() => {
musicLibrary.radioStations.mockResolvedValue(stations);
});
describe("when they all fit on the page", () => {
it("should return them all", async () => {
const paging = {
index: 0,
count: 100,
};
const result = await ws.getMetadataAsync({
id: `internetRadio`,
...paging,
});
expect(result[0]).toEqual(
getMetadataResult({
mediaMetadata: stations.map((it) =>
internetRadioStation(it)
),
index: 0,
total: stations.length,
})
);
expect(musicLibrary.radioStations).toHaveBeenCalled();
});
});
describe("asking for a single page of stations", () => {
const pageOfStations = [station3, station4];
it("should return only that page", async () => {
const paging = {
index: 2,
count: 2,
};
const result = await ws.getMetadataAsync({
id: `internetRadio`,
...paging,
});
expect(result[0]).toEqual(
getMetadataResult({
mediaMetadata: pageOfStations.map((it) =>
internetRadioStation(it)
),
index: paging.index,
total: stations.length,
})
);
expect(musicLibrary.radioStations).toHaveBeenCalled();
});
});
});
}); });
}); });
@@ -2898,7 +2778,7 @@ describe("wsdl api", () => {
id: `track:${track.id}`, id: `track:${track.id}`,
itemType: "track", itemType: "track",
title: track.name, title: track.name,
mimeType: track.mimeType, mimeType: track.encoding.mimeType,
trackMetadata: { trackMetadata: {
artistId: `artist:${track.artist.id}`, artistId: `artist:${track.artist.id}`,
artist: track.artist.name, artist: track.artist.name,
@@ -2909,7 +2789,7 @@ describe("wsdl api", () => {
genre: track.genre?.name, genre: track.genre?.name,
genreId: track.genre?.id, genreId: track.genre?.id,
duration: track.duration, duration: track.duration,
albumArtURI: defaultAlbumArtURI( albumArtURI: coverArtURI(
bonobUrlWithAccessToken, bonobUrlWithAccessToken,
track track
).href(), ).href(),
@@ -2946,7 +2826,7 @@ describe("wsdl api", () => {
id: `track:${track.id}`, id: `track:${track.id}`,
itemType: "track", itemType: "track",
title: track.name, title: track.name,
mimeType: track.mimeType, mimeType: track.encoding.mimeType,
trackMetadata: { trackMetadata: {
artistId: `artist:${track.artist.id}`, artistId: `artist:${track.artist.id}`,
artist: track.artist.name, artist: track.artist.name,
@@ -2957,7 +2837,7 @@ describe("wsdl api", () => {
genre: track.genre?.name, genre: track.genre?.name,
genreId: track.genre?.id, genreId: track.genre?.id,
duration: track.duration, duration: track.duration,
albumArtURI: defaultAlbumArtURI( albumArtURI: coverArtURI(
bonobUrlWithAccessToken, bonobUrlWithAccessToken,
track track
).href(), ).href(),
@@ -3000,7 +2880,7 @@ describe("wsdl api", () => {
itemType: "album", itemType: "album",
id: `album:${album.id}`, id: `album:${album.id}`,
title: album.name, title: album.name,
albumArtURI: defaultAlbumArtURI( albumArtURI: coverArtURI(
bonobUrlWithAccessToken, bonobUrlWithAccessToken,
album album
).href(), ).href(),
@@ -3065,6 +2945,27 @@ describe("wsdl api", () => {
expect(musicService.login).toHaveBeenCalledWith(serviceToken); expect(musicService.login).toHaveBeenCalledWith(serviceToken);
}); });
}); });
describe("asking for a URI to stream a radio station", () => {
const someStation = aRadioStation()
beforeEach(() => {
musicLibrary.radioStation.mockResolvedValue(someStation);
})
it("should return the radio stations uri", async () => {
const root = await ws.getMediaURIAsync({
id: `internetRadioStation:${someStation.id}`,
});
expect(root[0]).toEqual({
getMediaURIResult: someStation.url,
});
expect(musicService.login).toHaveBeenCalledWith(serviceToken);
expect(musicLibrary.radioStation).toHaveBeenCalledWith(someStation.id);
});
});
}); });
}); });
@@ -3076,7 +2977,6 @@ describe("wsdl api", () => {
describe("when valid credentials are provided", () => { describe("when valid credentials are provided", () => {
let ws: Client; let ws: Client;
const someTrack = aTrack();
beforeEach(async () => { beforeEach(async () => {
ws = await createClientAsync(`${service.uri}?wsdl`, { ws = await createClientAsync(`${service.uri}?wsdl`, {
@@ -3084,10 +2984,15 @@ describe("wsdl api", () => {
httpClient: supersoap(server), httpClient: supersoap(server),
}); });
setupAuthenticatedRequest(ws); setupAuthenticatedRequest(ws);
musicLibrary.track.mockResolvedValue(someTrack);
}); });
describe("asking for media metadata for a track", () => { describe("asking for media metadata for a track", () => {
const someTrack = aTrack();
beforeEach(async () => {
musicLibrary.track.mockResolvedValue(someTrack);
});
it("should return it with auth header", async () => { it("should return it with auth header", async () => {
const root = await ws.getMediaMetadataAsync({ const root = await ws.getMediaMetadataAsync({
id: `track:${someTrack.id}`, id: `track:${someTrack.id}`,
@@ -3106,6 +3011,27 @@ describe("wsdl api", () => {
expect(musicLibrary.track).toHaveBeenCalledWith(someTrack.id); expect(musicLibrary.track).toHaveBeenCalledWith(someTrack.id);
}); });
}); });
describe("asking for media metadata for an internet radio station", () => {
const someStation = aRadioStation()
beforeEach(() => {
musicLibrary.radioStation.mockResolvedValue(someStation);
})
it("should return it with no auth header", async () => {
const root = await ws.getMediaMetadataAsync({
id: `internetRadioStation:${someStation.id}`,
});
expect(root[0]).toEqual({
getMediaMetadataResult: internetRadioStation(someStation),
});
expect(musicService.login).toHaveBeenCalledWith(serviceToken);
expect(apiTokens.mint).toHaveBeenCalledWith(serviceToken);
expect(musicLibrary.radioStation).toHaveBeenCalledWith(someStation.id);
});
});
}); });
}); });

View File

@@ -0,0 +1,234 @@
import fs from "fs";
import path from "path";
import { SQLiteSmapiTokenStore } from "../src/sqlite_smapi_token_store";
import { SmapiToken } from "../src/smapi_auth";
import { JWTSmapiLoginTokens } from "../src/smapi_auth";
import { SystemClock } from "../src/clock";
describe("SQLiteSmapiTokenStore", () => {
const testDbPath = path.join(__dirname, "test-tokens.db");
const testJsonPath = path.join(__dirname, "test-tokens.json");
let tokenStore: SQLiteSmapiTokenStore;
beforeEach(() => {
// Clean up any existing test files
if (fs.existsSync(testDbPath)) {
fs.unlinkSync(testDbPath);
}
if (fs.existsSync(testJsonPath)) {
fs.unlinkSync(testJsonPath);
}
if (fs.existsSync(`${testJsonPath}.bak`)) {
fs.unlinkSync(`${testJsonPath}.bak`);
}
tokenStore = new SQLiteSmapiTokenStore(testDbPath);
});
afterEach(() => {
tokenStore.close();
// Clean up test files
if (fs.existsSync(testDbPath)) {
fs.unlinkSync(testDbPath);
}
if (fs.existsSync(testJsonPath)) {
fs.unlinkSync(testJsonPath);
}
if (fs.existsSync(`${testJsonPath}.bak`)) {
fs.unlinkSync(`${testJsonPath}.bak`);
}
});
describe("Database Initialization", () => {
it("should create database file on initialization", () => {
expect(fs.existsSync(testDbPath)).toBe(true);
});
it("should create parent directory if it doesn't exist", () => {
const nestedPath = path.join(__dirname, "nested", "dir", "tokens.db");
const nestedStore = new SQLiteSmapiTokenStore(nestedPath);
expect(fs.existsSync(nestedPath)).toBe(true);
nestedStore.close();
fs.unlinkSync(nestedPath);
fs.rmdirSync(path.dirname(nestedPath));
fs.rmdirSync(path.dirname(path.dirname(nestedPath)));
});
});
describe("Token Operations", () => {
const testToken: SmapiToken = {
token: "test-jwt-token",
key: "test-key-123",
};
it("should set and get a token", () => {
tokenStore.set("token1", testToken);
const retrieved = tokenStore.get("token1");
expect(retrieved).toEqual(testToken);
});
it("should return undefined for non-existent token", () => {
const retrieved = tokenStore.get("non-existent");
expect(retrieved).toBeUndefined();
});
it("should update existing token", () => {
tokenStore.set("token1", testToken);
const updatedToken: SmapiToken = {
token: "updated-jwt-token",
key: "updated-key-456",
};
tokenStore.set("token1", updatedToken);
const retrieved = tokenStore.get("token1");
expect(retrieved).toEqual(updatedToken);
});
it("should delete a token", () => {
tokenStore.set("token1", testToken);
tokenStore.delete("token1");
const retrieved = tokenStore.get("token1");
expect(retrieved).toBeUndefined();
});
it("should get all tokens", () => {
const token1: SmapiToken = { token: "jwt1", key: "key1" };
const token2: SmapiToken = { token: "jwt2", key: "key2" };
const token3: SmapiToken = { token: "jwt3", key: "key3" };
tokenStore.set("tokenKey1", token1);
tokenStore.set("tokenKey2", token2);
tokenStore.set("tokenKey3", token3);
const allTokens = tokenStore.getAll();
expect(Object.keys(allTokens).length).toBe(3);
expect(allTokens["tokenKey1"]).toEqual(token1);
expect(allTokens["tokenKey2"]).toEqual(token2);
expect(allTokens["tokenKey3"]).toEqual(token3);
});
it("should return empty object when no tokens exist", () => {
const allTokens = tokenStore.getAll();
expect(allTokens).toEqual({});
});
});
describe("Token Cleanup", () => {
it("should cleanup invalid tokens", () => {
const smapiAuthTokens = new JWTSmapiLoginTokens(SystemClock, "test-secret", "1h");
// Create valid tokens
const validToken1 = smapiAuthTokens.issue("service-token-1");
const validToken2 = smapiAuthTokens.issue("service-token-2");
// Create invalid token (wrong secret)
const invalidAuthTokens = new JWTSmapiLoginTokens(SystemClock, "different-secret", "1h");
const invalidToken = invalidAuthTokens.issue("service-token-3");
tokenStore.set("valid1", validToken1);
tokenStore.set("valid2", validToken2);
tokenStore.set("invalid", invalidToken);
// Clean up
const deletedCount = tokenStore.cleanupExpired(smapiAuthTokens);
expect(deletedCount).toBe(1);
expect(tokenStore.get("valid1")).toBeDefined();
expect(tokenStore.get("valid2")).toBeDefined();
expect(tokenStore.get("invalid")).toBeUndefined();
});
it("should not cleanup expired tokens that can be refreshed", () => {
// Note: This test would require mocking time to create an expired token
// For now, we just verify the function runs without error
const smapiAuthTokens = new JWTSmapiLoginTokens(SystemClock, "test-secret", "1h");
const validToken = smapiAuthTokens.issue("service-token-1");
tokenStore.set("token1", validToken);
const deletedCount = tokenStore.cleanupExpired(smapiAuthTokens);
expect(deletedCount).toBe(0);
expect(tokenStore.get("token1")).toBeDefined();
});
});
describe("JSON Migration", () => {
it("should migrate tokens from JSON file", () => {
const jsonTokens = {
token1: { token: "jwt1", key: "key1" },
token2: { token: "jwt2", key: "key2" },
token3: { token: "jwt3", key: "key3" },
};
fs.writeFileSync(testJsonPath, JSON.stringify(jsonTokens, null, 2), "utf8");
const migratedCount = tokenStore.migrateFromJSON(testJsonPath);
expect(migratedCount).toBe(3);
expect(tokenStore.get("token1")).toEqual(jsonTokens.token1);
expect(tokenStore.get("token2")).toEqual(jsonTokens.token2);
expect(tokenStore.get("token3")).toEqual(jsonTokens.token3);
});
it("should create backup of original JSON file", () => {
const jsonTokens = {
token1: { token: "jwt1", key: "key1" },
};
fs.writeFileSync(testJsonPath, JSON.stringify(jsonTokens, null, 2), "utf8");
tokenStore.migrateFromJSON(testJsonPath);
expect(fs.existsSync(`${testJsonPath}.bak`)).toBe(true);
expect(fs.existsSync(testJsonPath)).toBe(false);
});
it("should return 0 when JSON file does not exist", () => {
const migratedCount = tokenStore.migrateFromJSON(testJsonPath);
expect(migratedCount).toBe(0);
});
it("should handle empty JSON file", () => {
fs.writeFileSync(testJsonPath, JSON.stringify({}), "utf8");
const migratedCount = tokenStore.migrateFromJSON(testJsonPath);
expect(migratedCount).toBe(0);
});
});
describe("Persistence", () => {
it("should persist tokens across instances", () => {
const testToken: SmapiToken = { token: "jwt1", key: "key1" };
tokenStore.set("token1", testToken);
tokenStore.close();
// Create new instance with same database
const newStore = new SQLiteSmapiTokenStore(testDbPath);
const retrieved = newStore.get("token1");
expect(retrieved).toEqual(testToken);
newStore.close();
});
});
describe("Close", () => {
it("should close database connection without error", () => {
expect(() => tokenStore.close()).not.toThrow();
});
it("should handle multiple close calls gracefully", () => {
tokenStore.close();
// Second close should not throw
expect(() => tokenStore.close()).not.toThrow();
});
});
});

File diff suppressed because it is too large Load Diff

View File

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

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

View File

@@ -1,6 +1,12 @@
<% layout('./layout', { title: it.lang("failure") }) %> <% layout('./layout', { title: it.lang("failure") }) %>
<div id="content"> <div id="content">
<h1 class="failure"><%= it.message %></h1> <div class="message-container">
<h1 class="cause"><%= it.cause || "" %></h1> <div class="logo">✗</div>
<h1><%= it.message %></h1>
<% if (it.cause) { %>
<p style="color: #dc3545; margin-top: 15px;"><%= it.cause %></p>
<% } %>
<p style="color: #dc3545; font-weight: 600; margin-top: 10px;"><%= it.lang("failure") %></p>
</div>
</div> </div>

View File

@@ -1,45 +1,61 @@
<% layout('./layout') %> <% layout('./layout') %>
<div id="content"> <div id="content" class="index-content">
<div width="100%" style="text-align:right;color:grey"><%= it.version %></div> <div style="text-align:right;color:#999;font-size:0.85rem;margin-bottom:20px"><%= it.version %></div>
<h1><%= it.bonobService.name %> (<%= it.bonobService.sid %>)</h1> <div class="logo">🎵</div>
<h3><%= it.lang("expectedConfig") %></h3> <h1><%= it.bonobService.name %></h1>
<div><%= JSON.stringify(it.bonobService) %></div> <p style="color:#999;margin-bottom:30px">Service ID: <%= it.bonobService.sid %></p>
<br/>
<% if(it.devices.length > 0) { %> <% if(it.devices.length > 0) { %>
<form action="<%= it.createRegistrationRoute %>" method="POST"> <form action="<%= it.createRegistrationRoute %>" method="POST" style="margin-bottom:30px">
<input type="submit" value="<%= it.lang("register") %>"> <input type="submit" value="<%= it.lang("register") %>" id="submit">
</form> </form>
<br/>
<% } else { %> <% } else { %>
<h3><%= it.lang("noSonosDevices") %></h3> <p style="color:#dc3545;font-weight:600;margin:30px 0"><%= it.lang("noSonosDevices") %></p>
<br/>
<% } %> <% } %>
<% if(it.registeredBonobService) { %> <% if(it.registeredBonobService) { %>
<h3><%= it.lang("existingServiceConfig") %></h3> <div style="margin:20px 0;padding:15px;background:#f8f9fa;border-radius:8px">
<div><%= JSON.stringify(it.registeredBonobService) %></div> <h3 style="font-size:1.1rem;margin-bottom:10px;color:#667eea"><%= it.lang("existingServiceConfig") %></h3>
<pre style="font-size:0.85rem;text-align:left;overflow-x:auto"><%= JSON.stringify(it.registeredBonobService, null, 2) %></pre>
</div>
<% } else { %> <% } else { %>
<h3><%= it.lang("noExistingServiceRegistration") %></h3> <p style="color:#999;margin:20px 0"><%= it.lang("noExistingServiceRegistration") %></p>
<% } %> <% } %>
<% if(it.registeredBonobService) { %> <% if(it.registeredBonobService) { %>
<br/> <form action="<%= it.removeRegistrationRoute %>" method="POST" style="margin:20px 0">
<form action="<%= it.removeRegistrationRoute %>" method="POST"> <input type="submit" value="<%= it.lang("removeRegistration") %>" id="submit" style="background:#dc3545">
<input type="submit" value="<%= it.lang("removeRegistration") %>">
</form> </form>
<% } %> <% } %>
<br/> <div style="margin-top:40px;padding-top:30px;border-top:2px solid #e0e0e0">
<h2><%= it.lang("devices") %> (<%= it.devices.length %>)</h2> <h2 style="font-size:1.5rem;margin-bottom:15px"><%= it.lang("devices") %> (<%= it.devices.length %>)</h2>
<ul> <% if(it.devices.length > 0) { %>
<% it.devices.forEach(function(d){ %> <ul style="list-style:none;text-align:left;padding:0">
<li><%= d.name %> (<%= d.ip %>:<%= d.port %>)</li> <% it.devices.forEach(function(d){ %>
<% }) %> <li style="padding:10px;margin:5px 0;background:#f8f9fa;border-radius:6px">
</ul> <strong><%= d.name %></strong> <span style="color:#999">(<%= d.ip %>:<%= d.port %>)</span>
<h2><%= it.lang("services") %> (<%= it.services.length %>)</h2> </li>
<ul> <% }) %>
<% it.services.forEach(function(s){ %> </ul>
<li><%= s.name %> (<%= s.sid %>)</li> <% } else { %>
<% }) %> <p style="color:#999">No devices found</p>
</ul> <% } %>
</div>
<div style="margin-top:30px">
<h2 style="font-size:1.5rem;margin-bottom:15px"><%= it.lang("services") %> (<%= it.services.length %>)</h2>
<% if(it.services.length > 0) { %>
<ul style="list-style:none;text-align:left;padding:0">
<% it.services.forEach(function(s){ %>
<li style="padding:10px;margin:5px 0;background:#f8f9fa;border-radius:6px">
<strong><%= s.name %></strong> <span style="color:#999">(SID: <%= s.sid %>)</span>
</li>
<% }) %>
</ul>
<% } else { %>
<p style="color:#999">No services registered</p>
<% } %>
</div>
</div> </div>

View File

@@ -1,46 +1,189 @@
<!DOCTYPE html> <!DOCTYPE html>
<html lang="en"> <html lang="en">
<head> <head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title><%= it.title || "bonob" %></title> <title><%= it.title || "bonob" %></title>
<style> <style>
* {
margin: 0;
padding: 0;
box-sizing: border-box;
}
body { body {
font-family: -apple-system,BlinkMacSystemFont,"Segoe UI","Roboto","Oxygen","Ubuntu","Cantarell","Fira Sans","Droid Sans","Helvetica Neue",sans-serif; font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "Roboto", "Oxygen", "Ubuntu", "Cantarell", "Fira Sans", "Droid Sans", "Helvetica Neue", sans-serif;
} background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);
min-height: 100vh;
display: flex;
align-items: center;
justify-content: center;
padding: 20px;
}
div#content { div#content {
margin: auto; background: white;
width: 60%; border-radius: 20px;
box-shadow: 0 20px 60px rgba(0, 0, 0, 0.3);
padding: 50px 40px;
max-width: 450px;
width: 100%;
animation: slideIn 0.5s ease-out;
}
@keyframes slideIn {
from {
opacity: 0;
transform: translateY(-30px);
}
to {
opacity: 1;
transform: translateY(0);
}
} }
h1 { h1 {
font-size: 700%; font-size: 2.5rem;
font-weight: 700;
color: #333;
text-align: center;
margin-bottom: 40px;
background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);
-webkit-background-clip: text;
-webkit-text-fill-color: transparent;
background-clip: text;
}
form {
display: flex;
flex-direction: column;
gap: 25px;
}
.form-group {
display: flex;
flex-direction: column;
gap: 8px;
} }
label { label {
font-size: 300%; font-size: 0.95rem;
font-weight: 600;
color: #555;
margin-left: 5px;
} }
input { input[type="text"],
font-size: 300%; input[type="password"] {
width: 80%; width: 100%;
padding: 15px 20px;
font-size: 1rem;
border: 2px solid #e0e0e0;
border-radius: 12px;
transition: all 0.3s ease;
background: #f8f9fa;
}
input[type="text"]:focus,
input[type="password"]:focus {
outline: none;
border-color: #667eea;
background: white;
box-shadow: 0 0 0 4px rgba(102, 126, 234, 0.1);
transform: translateY(-2px);
} }
input#submit { input#submit {
margin-top: 100px width: 100%;
padding: 16px;
font-size: 1.1rem;
font-weight: 600;
color: white;
background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);
border: none;
border-radius: 12px;
cursor: pointer;
transition: all 0.3s ease;
margin-top: 10px;
box-shadow: 0 4px 15px rgba(102, 126, 234, 0.4);
} }
.one-word-per-line { input#submit:hover {
word-spacing: 100000px; transform: translateY(-2px);
box-shadow: 0 6px 20px rgba(102, 126, 234, 0.5);
} }
.login{ input#submit:active {
width: min-intrinsic; transform: translateY(0);
width: -webkit-min-content; }
width: -moz-min-content;
width: min-content; .logo {
display: table-caption; text-align: center;
display: -ms-grid; margin-bottom: 20px;
-ms-grid-columns: min-content; font-size: 3rem;
opacity: 0.9;
}
/* Success and failure page styles */
.message-container {
text-align: center;
padding: 20px 0;
}
.message-container h1 {
font-size: 2rem;
margin-bottom: 20px;
}
.message-container p {
font-size: 1.1rem;
color: #666;
line-height: 1.6;
}
/* Index page styles */
.index-content {
text-align: center;
}
.index-content h1 {
font-size: 2.5rem;
margin-bottom: 20px;
}
.index-content p {
font-size: 1.1rem;
color: #666;
line-height: 1.8;
margin-bottom: 15px;
}
.index-content a {
color: #667eea;
text-decoration: none;
font-weight: 600;
transition: color 0.3s ease;
}
.index-content a:hover {
color: #764ba2;
text-decoration: underline;
}
/* Responsive design */
@media (max-width: 500px) {
div#content {
padding: 40px 30px;
}
h1 {
font-size: 2rem;
}
input[type="text"],
input[type="password"] {
padding: 12px 16px;
}
} }
</style> </style>
</head> </head>

View File

@@ -1,12 +1,17 @@
<% layout('./layout', { title: it.lang("login") }) %> <% layout('./layout', { title: it.lang("login") }) %>
<div id="content"> <div id="content">
<h1 class="login one-word-per-line"><%= it.lang("logInToBonob") %></h1> <div class="logo">🎵</div>
<h1><%= it.lang("logInToBonob") %></h1>
<form action="<%= it.loginRoute %>" method="POST"> <form action="<%= it.loginRoute %>" method="POST">
<label for="username"><%= it.lang("username") %>:</label><br> <div class="form-group">
<input type="text" id="username" name="username"><br><br> <label for="username"><%= it.lang("username") %></label>
<label for="password"><%= it.lang("password") %>:</label><br> <input type="text" id="username" name="username" required autofocus>
<input type="password" id="password" name="password"><br> </div>
<div class="form-group">
<label for="password"><%= it.lang("password") %></label>
<input type="password" id="password" name="password" required>
</div>
<input type="hidden" name="linkCode" value="<%= it.linkCode %>"> <input type="hidden" name="linkCode" value="<%= it.linkCode %>">
<input type="submit" value="<%= it.lang("login") %>" id="submit"> <input type="submit" value="<%= it.lang("login") %>" id="submit">
</form> </form>

View File

@@ -1,5 +1,9 @@
<% layout('./layout', { title: it.lang("success") }) %> <% layout('./layout', { title: it.lang("success") }) %>
<div id="content"> <div id="content">
<h1 class="success"><%= it.message %></h1> <div class="message-container">
<div class="logo">✓</div>
<h1><%= it.message %></h1>
<p style="color: #28a745; font-weight: 600; margin-top: 10px;"><%= it.lang("success") %></p>
</div>
</div> </div>

4553
yarn.lock

File diff suppressed because it is too large Load Diff