Compare commits
18 Commits
1fd8e13668
...
feature/nd
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
add87e5df9 | ||
|
|
38f53168fa | ||
|
|
166a4b5ec2 | ||
|
|
eb66393fe6 | ||
|
|
730524d7a1 | ||
|
|
1b14b88fb4 | ||
|
|
d2f13416f6 | ||
|
|
2997e5ac3b | ||
|
|
d1ff224e89 | ||
|
|
ac266a3c46 | ||
|
|
25857d7e5a | ||
|
|
50cb5b2550 | ||
|
|
e37a09c266 | ||
|
|
88661d7c26 | ||
|
|
6ad39ce044 | ||
|
|
1c94a6d565 | ||
|
|
00944a7a25 | ||
|
|
c7352aefa3 |
@@ -1,16 +0,0 @@
|
||||
FROM node:22-bullseye
|
||||
|
||||
LABEL maintainer=simojenki
|
||||
|
||||
ENV JEST_TIMEOUT=60000
|
||||
EXPOSE 4534
|
||||
|
||||
RUN apt-get update && \
|
||||
apt-get -y upgrade && \
|
||||
apt-get -y install --no-install-recommends \
|
||||
libvips-dev \
|
||||
python3 \
|
||||
make \
|
||||
git \
|
||||
g++ \
|
||||
vim
|
||||
@@ -1,28 +0,0 @@
|
||||
{
|
||||
"name": "bonob",
|
||||
"build": {
|
||||
"dockerfile": "Dockerfile"
|
||||
},
|
||||
"containerEnv": {
|
||||
// these env vars need to be configured appropriately for your local dev env
|
||||
"BNB_DEV_SONOS_DEVICE_IP": "${localEnv:BNB_DEV_SONOS_DEVICE_IP}",
|
||||
"BNB_DEV_HOST_IP": "${localEnv:BNB_DEV_HOST_IP}",
|
||||
"BNB_DEV_SUBSONIC_URL": "${localEnv:BNB_DEV_SUBSONIC_URL}"
|
||||
},
|
||||
"remoteUser": "node",
|
||||
"forwardPorts": [4534],
|
||||
"features": {
|
||||
"ghcr.io/devcontainers/features/docker-in-docker:2": {
|
||||
"version": "latest",
|
||||
"moby": true
|
||||
}
|
||||
},
|
||||
"customizations": {
|
||||
"vscode": {
|
||||
"extensions": [
|
||||
"esbenp.prettier-vscode",
|
||||
"redhat.vscode-xml"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,6 +0,0 @@
|
||||
.devcontainer
|
||||
.github
|
||||
.yarn/cache
|
||||
.yarn/install-state.gz
|
||||
build
|
||||
node_modules
|
||||
40
.github/workflows/ci.yml
vendored
@@ -17,60 +17,52 @@ jobs:
|
||||
steps:
|
||||
-
|
||||
name: Check out the repo
|
||||
uses: actions/checkout@v3
|
||||
uses: actions/checkout@v2
|
||||
-
|
||||
uses: actions/setup-node@v3
|
||||
uses: actions/setup-node@v1
|
||||
with:
|
||||
node-version: 20
|
||||
node-version: '16'
|
||||
-
|
||||
run: npm install
|
||||
run: yarn install
|
||||
-
|
||||
run: npm test
|
||||
run: yarn test
|
||||
|
||||
|
||||
push_to_registry:
|
||||
name: Push Docker image to Docker registries
|
||||
name: Push Docker image to Docker Hub
|
||||
needs: build_and_test
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
-
|
||||
name: Check out the repo
|
||||
uses: actions/checkout@v3
|
||||
uses: actions/checkout@v2
|
||||
with:
|
||||
fetch-depth: 0
|
||||
-
|
||||
name: Set up QEMU
|
||||
uses: docker/setup-qemu-action@v2
|
||||
uses: docker/setup-qemu-action@v1
|
||||
-
|
||||
name: Set up Docker Buildx
|
||||
uses: docker/setup-buildx-action@v2
|
||||
uses: docker/setup-buildx-action@v1
|
||||
-
|
||||
name: Docker meta
|
||||
id: meta
|
||||
uses: docker/metadata-action@v5
|
||||
uses: docker/metadata-action@v3
|
||||
with:
|
||||
images: |
|
||||
simojenki/bonob
|
||||
ghcr.io/simojenki/bonob
|
||||
images: simojenki/bonob
|
||||
-
|
||||
name: Login to DockerHub
|
||||
uses: docker/login-action@v2
|
||||
if: github.event_name != 'pull_request'
|
||||
uses: docker/login-action@v1
|
||||
with:
|
||||
username: ${{ secrets.DOCKERHUB_USERNAME }}
|
||||
password: ${{ secrets.DOCKERHUB_TOKEN }}
|
||||
-
|
||||
name: Log in to GitHub Container registry
|
||||
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
|
||||
name: Push to Docker Hub
|
||||
uses: docker/build-push-action@v2
|
||||
with:
|
||||
context: .
|
||||
platforms: linux/amd64,linux/arm/v7,linux/arm64
|
||||
push: true
|
||||
push: ${{ github.event_name != 'pull_request' }}
|
||||
tags: ${{ steps.meta.outputs.tags }}
|
||||
labels: ${{ steps.meta.outputs.labels }}
|
||||
4
.gitignore
vendored
@@ -2,7 +2,6 @@
|
||||
.vscode
|
||||
build
|
||||
ignore
|
||||
.ignore
|
||||
node_modules
|
||||
.yarn/*
|
||||
!.yarn/patches
|
||||
@@ -11,6 +10,3 @@ node_modules
|
||||
!.yarn/sdks
|
||||
!.yarn/versions
|
||||
.pnp.*
|
||||
log.txt
|
||||
navidrome.txt
|
||||
bonob.txt
|
||||
|
||||
631
.yarn/releases/yarn-berry.cjs
vendored
Executable file
3
.yarnrc.yml
Normal file
@@ -0,0 +1,3 @@
|
||||
nodeLinker: node-modules
|
||||
|
||||
yarnPath: .yarn/releases/yarn-berry.cjs
|
||||
187
CLAUDE.md
@@ -1,187 +0,0 @@
|
||||
# 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
|
||||
@@ -1,91 +0,0 @@
|
||||
# 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.
|
||||
39
Dockerfile
@@ -1,4 +1,4 @@
|
||||
FROM node:22-trixie-slim AS build
|
||||
FROM node:16-bullseye as build
|
||||
|
||||
WORKDIR /bonob
|
||||
|
||||
@@ -9,13 +9,14 @@ COPY typings ./typings
|
||||
COPY web ./web
|
||||
COPY tests ./tests
|
||||
COPY jest.config.js .
|
||||
COPY register.js .
|
||||
COPY .npmrc .
|
||||
COPY tsconfig.json .
|
||||
COPY package.json .
|
||||
COPY package-lock.json .
|
||||
COPY register.js .
|
||||
COPY tsconfig.json .
|
||||
COPY yarn.lock .
|
||||
COPY .yarnrc.yml .
|
||||
COPY .yarn/releases ./.yarn/releases
|
||||
|
||||
ENV JEST_TIMEOUT=60000
|
||||
ENV JEST_TIMEOUT=30000
|
||||
ENV DEBIAN_FRONTEND=noninteractive
|
||||
|
||||
RUN apt-get update && \
|
||||
@@ -28,20 +29,13 @@ RUN apt-get update && \
|
||||
g++ && \
|
||||
apt-get clean && \
|
||||
rm -rf /var/lib/apt/lists/* && \
|
||||
npm install && \
|
||||
npm test && \
|
||||
npm run gitinfo && \
|
||||
npm run build && \
|
||||
rm -Rf node_modules && \
|
||||
NODE_ENV=production npm install --omit=dev
|
||||
yarn install --immutable && \
|
||||
yarn gitinfo && \
|
||||
yarn test --no-cache && \
|
||||
yarn build
|
||||
|
||||
|
||||
FROM node:22-trixie-slim
|
||||
|
||||
LABEL maintainer="simojenki" \
|
||||
org.opencontainers.image.source="https://github.com/simojenki/bonob" \
|
||||
org.opencontainers.image.description="bonob SONOS SMAPI implementation" \
|
||||
org.opencontainers.image.licenses="GPLv3"
|
||||
FROM node:16-bullseye
|
||||
|
||||
ENV BNB_PORT=4534
|
||||
ENV DEBIAN_FRONTEND=noninteractive
|
||||
@@ -52,20 +46,17 @@ EXPOSE $BNB_PORT
|
||||
WORKDIR /bonob
|
||||
|
||||
COPY package.json .
|
||||
COPY package-lock.json .
|
||||
COPY yarn.lock .
|
||||
|
||||
COPY --from=build /bonob/build/src ./src
|
||||
COPY --from=build /bonob/node_modules ./node_modules
|
||||
COPY --from=build /bonob/.gitinfo ./
|
||||
COPY web ./web
|
||||
COPY src/Sonoswsdl-1.19.6-20231024.wsdl ./src/Sonoswsdl-1.19.6-20231024.wsdl
|
||||
COPY src/Sonoswsdl-1.19.4-20190411.142401-3.wsdl ./src/Sonoswsdl-1.19.4-20190411.142401-3.wsdl
|
||||
|
||||
RUN apt-get update && \
|
||||
apt-get -y upgrade && \
|
||||
apt-get -y install --no-install-recommends \
|
||||
libvips \
|
||||
tzdata \
|
||||
wget && \
|
||||
apt-get -y install --no-install-recommends libvips tzdata && \
|
||||
apt-get clean && \
|
||||
rm -rf /var/lib/apt/lists/*
|
||||
|
||||
|
||||
66
README.md
@@ -9,40 +9,23 @@ Support for Subsonic API clones (tested against Navidrome and Gonic).
|
||||
## Features
|
||||
|
||||
- Integrates with Subsonic API clones (Navidrome, Gonic)
|
||||
- Browse by Artist, Albums, Random, Favourites, Top Rated, Playlist, Genres, Years, Recently Added Albums, Recently Played Albums, Most Played Albums
|
||||
- Browse by Artist, Albums, Random, Favourites, Top Rated, Playlist, Genres, Recently Added Albums, Recently Played Albums, Most Played Albums
|
||||
- Artist & Album Art
|
||||
- View Related Artists via Artist -> '...' -> Menu -> Related Arists
|
||||
- Now playing & Track Scrobbling
|
||||
- Search by Album, Artist, Track
|
||||
- Playlist editing through sonos app.
|
||||
- Marking of songs as favourites and with ratings through the sonos app.
|
||||
- Localization (only en-US, da-DK, nl-NL & fr-FR supported currently, require translations for other languages). [Sonos localization and supported languages](https://docs.sonos.com/docs/localization)
|
||||
- Localization (only en-US & nl-NL supported currently, require translations for other languages). [Sonos localization and supported languages](https://developer.sonos.com/build/content-service-add-features/strings-and-localization/)
|
||||
- Auto discovery of sonos devices
|
||||
- Discovery of sonos devices using seed IP address
|
||||
- Auto registration with sonos on start
|
||||
- Multiple registrations within a single household.
|
||||
- Transcoding within subsonic clone
|
||||
- Custom players by mime type, allowing custom transcoding rules for different file types
|
||||
- Transcoding support for flacs using a specific player for the flac mimeType bonob/sonos
|
||||
|
||||
## Running
|
||||
|
||||
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
|
||||
|
||||
bonob is distributed via docker and can be run in a number of ways
|
||||
|
||||
### Full sonos device auto-discovery and auto-registration using docker --network host
|
||||
|
||||
@@ -143,8 +126,8 @@ services:
|
||||
# ip address of your machine running bonob
|
||||
BNB_URL: http://192.168.1.111:4534
|
||||
BNB_SECRET: changeme
|
||||
BNB_SONOS_AUTO_REGISTER: "true"
|
||||
BNB_SONOS_DEVICE_DISCOVERY: "true"
|
||||
BNB_SONOS_AUTO_REGISTER: true
|
||||
BNB_SONOS_DEVICE_DISCOVERY: true
|
||||
BNB_SONOS_SERVICE_ID: 246
|
||||
# ip address of one of your sonos devices
|
||||
BNB_SONOS_SEED_HOST: 192.168.1.121
|
||||
@@ -163,16 +146,14 @@ 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_SECRET | bonob | secret used for encrypting credentials
|
||||
BNB_AUTH_TIMEOUT | 1h | Timeout for the sonos auth token, described in the format [ms](https://github.com/vercel/ms), ie. '5s' == 5 seconds, '11h' == 11 hours. In the case of using Navidrome this should be less than the value for ND_SESSIONTIMEOUT
|
||||
BNB_LOG_LEVEL | info | Log level. One of ['debug', 'info', 'warn', 'error']
|
||||
BNB_SERVER_LOG_REQUESTS | false | Whether or not to log http requests
|
||||
BNB_SONOS_AUTO_REGISTER | false | Whether or not to try and auto-register on startup
|
||||
BNB_SONOS_DEVICE_DISCOVERY | true | Enable/Disable sonos device discovery entirely. Setting this to 'false' will disable sonos device search, regardless of whether a seed host is specified.
|
||||
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_ID | 246 | service id for sonos
|
||||
BNB_SUBSONIC_URL | http://$(hostname):4533 | URL for subsonic clone
|
||||
BNB_SUBSONIC_CUSTOM_CLIENTS | undefined | Comma delimeted mime types for custom subsonic clients when streaming. <P>Must specify the source mime type and optionally the transcoded mime type. <p>For example; <p>If you want to simply re-encode some flacs, then you could specify just "audio/flac". <p>However; <p>if your subsonic server will transcode the track then you need to specify the resulting mime type, ie. "audio/flac>audio/mp3" <p>If you want to specify many something like; "audio/flac>audio/mp3,audio/ogg" would use client = 'bonob+audio/flac' for flacs, and 'bonob+audio/ogg' for oggs. <p>Disclaimer: Getting this configuration wrong will cause sonos to refuse to play your music, by all means experiment, however know that this may well break your setup.
|
||||
BNB_SUBSONIC_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_CUSTOM_CLIENTS | undefined | Comma delimeted mime types for custom subsonic clients when streaming. ie. "audio/flac,audio/ogg" would use client = 'bonob+audio/flac' for flacs, and 'bonob+audio/ogg' for oggs.
|
||||
BNB_SUBSONIC_ARTIST_IMAGE_CACHE | undefined | Path for caching of artist images as are sourced externally. ie. Navidrome provides spotify URLs
|
||||
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_ICON_FOREGROUND_COLOR | undefined | Icon foreground color in sonos app, must be a valid [svg color](https://www.december.com/html/spec/colorsvg.html)
|
||||
@@ -207,33 +188,24 @@ Generally speaking you will not need to do this very often. However on occassio
|
||||
|
||||
Service should now be registered and everything should work as expected.
|
||||
|
||||
## Multiple registrations within a single household.
|
||||
|
||||
It's possible to register multiple Subsonic clone users for the bonob service in Sonos.
|
||||
Basically this consist of repeating the Sonos app ["Add a service"](#initialising-service-within-sonos-app) steps for each additional user.
|
||||
Afterwards the Sonos app displays a dropdown underneath the service, allowing to switch between users.
|
||||
|
||||
## Implementing a different music source other than a subsonic clone
|
||||
|
||||
- Implement the MusicService/MusicLibrary interface
|
||||
- Startup bonob with your new implementation.
|
||||
|
||||
## Transcoding
|
||||
## A note on transcoding
|
||||
|
||||
### Transcode everything
|
||||
tldr; Transcoding to mp3/m4a is not supported as sonos devices will not play the track. However transcoding to flac does work, use BNB_SUBSONIC_CUSTOM_CLIENTS=audio/flac if you want to transcode flac->flac ie. to downsample HD flacs (see below).
|
||||
|
||||
The simplest transcoding solution is to simply change the player ('bonob') in your subsonic server to transcode all content to something sonos supports (ie. mp3 & flac)
|
||||
Sonos devices are very particular about how audio streams are presented to them, see [streaming basics](https://developer.sonos.com/build/content-service-add-features/streaming-basics/). When using transcoding both Navidrome and Gonic report no 'content-length', nor do they support range queries, this will cause the sonos device to fail to play the track.
|
||||
|
||||
### Audio file type specific transcoding
|
||||
### Audio File type specific transcoding options within Subsonic
|
||||
|
||||
Disclaimer: The following configuration is more complicated, and if you get the configuration wrong sonos will refuse to play your content.
|
||||
|
||||
In some situations you may wish to have different 'Players' within your Subsonic server so that you can configure different transcoding options depending on the file type. For example if you have flacs with a mixture of frequency formats where not all are supported by sonos [See issue #52](https://github.com/simojenki/bonob/issues/52) & [Sonos supported audio formats](https://docs.sonos.com/docs/supported-audio-formats)
|
||||
In some situations you may wish to have different 'Players' within you Subsonic server so that you can configure different transcoding options depending on the file type. For example if you have flacs with a mixture of frequency formats where not all are supported by sonos [See issue #52](https://github.com/simojenki/bonob/issues/52) & [Sonos supported audio formats](https://developer.sonos.com/build/content-service-add-features/supported-audio-formats/)
|
||||
|
||||
In this case you could set;
|
||||
|
||||
```bash
|
||||
# This is equivalent to setting BNB_SUBSONIC_CUSTOM_CLIENTS="audio/flac>audio/flac"
|
||||
BNB_SUBSONIC_CUSTOM_CLIENTS="audio/flac"
|
||||
```
|
||||
|
||||
@@ -249,16 +221,7 @@ ffmpeg -i %s -af aformat=sample_fmts=s16|s32:sample_rates=8000|11025|16000|22050
|
||||
ffmpeg -i %s -af aformat=sample_fmts=s16:sample_rates=8000|11025|16000|22050|24000|32000|44100|48000 -f flac -
|
||||
```
|
||||
|
||||
Alternatively perhaps you have some aac (audio/mpeg) files that will not play in sonos (ie. voice recordings from an iPhone), however you do not want to transcode all everything, just those audio/mpeg files. Let's say you want to transcode them to mp3s, you could set the following;
|
||||
|
||||
```bash
|
||||
BNB_SUBSONIC_CUSTOM_CLIENTS="audio/mpeg>audio/mp3"
|
||||
```
|
||||
|
||||
And then configure the 'bonob+audio/mpeg' player in your subsonic server.
|
||||
|
||||
|
||||
## Changing Icon colors
|
||||
### Changing Icon colors
|
||||
|
||||
```bash
|
||||
-e BNB_ICON_FOREGROUND_COLOR=white \
|
||||
@@ -288,7 +251,6 @@ And then configure the 'bonob+audio/mpeg' player in your subsonic server.
|
||||
|
||||

|
||||
|
||||
|
||||
## Credits
|
||||
|
||||
- Icons courtesy of: [Navidrome](https://www.navidrome.org/), [Vectornator](https://www.vectornator.io/icons), and @jicho
|
||||
|
||||
45
UPDATES.md
@@ -1,45 +0,0 @@
|
||||
# Updates for SMAPI
|
||||
|
||||
Run Bonob on your server.
|
||||
|
||||
Bonob now needs a volume to store OAuth Tokens. 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 directory should be owned by that user.
|
||||
|
||||
Example systemd file (`/usr/lib/systemd/system/bonob.service`):
|
||||
```
|
||||
[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
|
||||
```
|
||||
@@ -27,8 +27,8 @@ services:
|
||||
BNB_URL: http://192.168.1.111:4534
|
||||
BNB_SECRET: changeme
|
||||
BNB_SONOS_SERVICE_ID: 246
|
||||
BNB_SONOS_AUTO_REGISTER: "true"
|
||||
BNB_SONOS_DEVICE_DISCOVERY: "true"
|
||||
BNB_SONOS_AUTO_REGISTER: true
|
||||
BNB_SONOS_DEVICE_DISCOVERY: true
|
||||
# ip address of one of your sonos devices
|
||||
BNB_SONOS_SEED_HOST: 192.168.1.121
|
||||
BNB_SUBSONIC_URL: http://navidrome:4533
|
||||
|
||||
@@ -6,5 +6,4 @@ module.exports = {
|
||||
'<rootDir>/node_modules',
|
||||
'<rootDir>/build',
|
||||
],
|
||||
testTimeout: Number.parseInt(process.env["JEST_TIMEOUT"] || "5000")
|
||||
};
|
||||
7831
package-lock.json
generated
100
package.json
@@ -6,72 +6,64 @@
|
||||
"author": "simojenki <simojenki@users.noreply.github.com>",
|
||||
"license": "GPL-3.0-only",
|
||||
"dependencies": {
|
||||
"@svrooij/sonos": "^2.6.0-beta.11",
|
||||
"@types/express": "^4.17.21",
|
||||
"@types/fs-extra": "^11.0.4",
|
||||
"@types/jsonwebtoken": "^9.0.7",
|
||||
"@types/jws": "^3.2.10",
|
||||
"@types/morgan": "^1.9.9",
|
||||
"@types/node": "^20.11.5",
|
||||
"@types/randomstring": "^1.3.0",
|
||||
"@types/underscore": "^1.13.0",
|
||||
"@types/uuid": "^10.0.0",
|
||||
"@types/xmldom": "^0.1.34",
|
||||
"@xmldom/xmldom": "^0.9.7",
|
||||
"axios": "^1.7.8",
|
||||
"better-sqlite3": "^12.4.1",
|
||||
"dayjs": "^1.11.13",
|
||||
"eta": "^2.2.0",
|
||||
"express": "^4.18.3",
|
||||
"fp-ts": "^2.16.9",
|
||||
"fs-extra": "^11.2.0",
|
||||
"jsonwebtoken": "^9.0.2",
|
||||
"@svrooij/sonos": "^2.4.0",
|
||||
"@types/express": "^4.17.13",
|
||||
"@types/fs-extra": "^9.0.13",
|
||||
"@types/jsonwebtoken": "^8.5.5",
|
||||
"@types/jws": "^3.2.4",
|
||||
"@types/morgan": "^1.9.3",
|
||||
"@types/node": "^16.7.13",
|
||||
"@types/randomstring": "^1.1.8",
|
||||
"@types/sharp": "^0.28.6",
|
||||
"@types/underscore": "^1.11.3",
|
||||
"@types/uuid": "^8.3.1",
|
||||
"axios": "^0.21.4",
|
||||
"dayjs": "^1.10.6",
|
||||
"eta": "^1.12.3",
|
||||
"express": "^4.17.1",
|
||||
"fp-ts": "^2.11.1",
|
||||
"fs-extra": "^10.0.0",
|
||||
"jsonwebtoken": "^8.5.1",
|
||||
"jws": "^4.0.0",
|
||||
"libxmljs2": "^0.28.0",
|
||||
"morgan": "^1.10.0",
|
||||
"node-html-parser": "^6.1.13",
|
||||
"randomstring": "^1.3.0",
|
||||
"sharp": "^0.33.5",
|
||||
"soap": "^1.1.6",
|
||||
"ts-md5": "^1.3.1",
|
||||
"typescript": "^5.7.2",
|
||||
"underscore": "^1.13.7",
|
||||
"node-html-parser": "^4.1.4",
|
||||
"randomstring": "^1.2.1",
|
||||
"sharp": "^0.29.1",
|
||||
"soap": "^0.42.0",
|
||||
"ts-md5": "^1.2.9",
|
||||
"typescript": "^4.4.2",
|
||||
"underscore": "^1.13.1",
|
||||
"urn-lib": "^2.0.0",
|
||||
"uuid": "^11.0.3",
|
||||
"winston": "^3.17.0",
|
||||
"xmldom-ts": "^0.3.1",
|
||||
"xpath": "^0.0.34"
|
||||
"uuid": "^8.3.2",
|
||||
"winston": "^3.3.3"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/better-sqlite3": "^7.6.13",
|
||||
"@types/chai": "^5.0.1",
|
||||
"@types/jest": "^29.5.14",
|
||||
"@types/mocha": "^10.0.10",
|
||||
"@types/supertest": "^6.0.2",
|
||||
"@types/tmp": "^0.2.6",
|
||||
"chai": "^5.1.2",
|
||||
"get-port": "^7.1.0",
|
||||
"image-js": "^0.35.6",
|
||||
"jest": "^29.7.0",
|
||||
"nodemon": "^3.1.7",
|
||||
"supertest": "^7.0.0",
|
||||
"tmp": "^0.2.3",
|
||||
"ts-jest": "^29.2.5",
|
||||
"@types/chai": "^4.2.21",
|
||||
"@types/jest": "^27.0.1",
|
||||
"@types/mocha": "^9.0.0",
|
||||
"@types/supertest": "^2.0.11",
|
||||
"@types/tmp": "^0.2.1",
|
||||
"chai": "^4.3.4",
|
||||
"get-port": "^5.1.1",
|
||||
"image-js": "^0.33.0",
|
||||
"jest": "^27.1.0",
|
||||
"nodemon": "^2.0.12",
|
||||
"supertest": "^6.1.6",
|
||||
"tmp": "^0.2.1",
|
||||
"ts-jest": "^27.0.5",
|
||||
"ts-mockito": "^2.6.1",
|
||||
"ts-node": "^10.9.2",
|
||||
"ts-node": "^10.2.1",
|
||||
"xmldom-ts": "^0.3.1",
|
||||
"xpath-ts": "^1.3.13"
|
||||
},
|
||||
"overrides": {
|
||||
"axios-ntlm": "npm:dry-uninstall",
|
||||
"axios": "$axios"
|
||||
},
|
||||
"scripts": {
|
||||
"clean": "rm -Rf build node_modules",
|
||||
"build": "tsc",
|
||||
"dev": "BNB_SUBSONIC_CUSTOM_CLIENTS1=audio/flac,audio/mpeg,audio/mp4\\>audio/flac BNB_LOG_LEVEL=debug BNB_DEBUG=true BNB_SCROBBLE_TRACKS=false BNB_REPORT_NOW_PLAYING=false BNB_SONOS_SEED_HOST=$BNB_DEV_SONOS_DEVICE_IP BNB_SONOS_SERVICE_NAME=z_bonobDev BNB_URL=\"http://${BNB_DEV_HOST_IP}:4534\" BNB_SUBSONIC_URL=\"${BNB_DEV_SUBSONIC_URL}\" nodemon -V ./src/app.ts",
|
||||
"devr": "BNB_LOG_LEVEL=debug BNB_DEBUG=true BNB_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://${BNB_DEV_HOST_IP}:4534",
|
||||
"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=z_bonobDev BNB_SONOS_DEVICE_DISCOVERY=true 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=z_bonobDev BNB_SONOS_DEVICE_DISCOVERY=true BNB_SONOS_AUTO_REGISTER=true nodemon -V ./src/app.ts",
|
||||
"register-dev": "ts-node ./src/register.ts http://$(hostname):4534",
|
||||
"test": "jest",
|
||||
"testw": "jest --watch",
|
||||
"gitinfo": "git describe --tags > .gitinfo"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,85 +0,0 @@
|
||||
= 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.
|
||||
|
Before Width: | Height: | Size: 37 KiB |
|
Before Width: | Height: | Size: 15 KiB |
|
Before Width: | Height: | Size: 32 KiB |
|
Before Width: | Height: | Size: 2.1 KiB |
|
Before Width: | Height: | Size: 73 KiB |
|
Before Width: | Height: | Size: 4.1 KiB |
|
Before Width: | Height: | Size: 10 KiB |
@@ -1,18 +0,0 @@
|
||||
<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>
|
||||
|
Before Width: | Height: | Size: 1.1 KiB |
@@ -1,19 +0,0 @@
|
||||
<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>
|
||||
|
Before Width: | Height: | Size: 950 B |
@@ -1,20 +0,0 @@
|
||||
<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>
|
||||
|
Before Width: | Height: | Size: 877 B |
@@ -97,7 +97,7 @@
|
||||
<xs:complexType>
|
||||
<xs:sequence>
|
||||
<xs:element name="token" type="xs:string"/>
|
||||
<xs:element name="key" type="xs:string" minOccurs="0"/>
|
||||
<xs:element name="key" type="xs:string"/>
|
||||
<xs:element name="householdId" type="xs:string"/>
|
||||
</xs:sequence>
|
||||
</xs:complexType>
|
||||
@@ -111,12 +111,11 @@
|
||||
</xs:simpleType>
|
||||
</xs:element>
|
||||
|
||||
<xs:simpleType name="userAccountTier">
|
||||
<xs:simpleType name="userAccountType">
|
||||
<xs:restriction base="xs:string">
|
||||
<xs:enumeration value="paidPremium"/>
|
||||
<xs:enumeration value="paidLimited"/>
|
||||
<xs:enumeration value="premium"/>
|
||||
<xs:enumeration value="trial"/>
|
||||
<xs:enumeration value="free"/>
|
||||
<xs:enumeration value="none"/>
|
||||
</xs:restriction>
|
||||
</xs:simpleType>
|
||||
|
||||
@@ -240,12 +239,6 @@
|
||||
</xs:simpleContent>
|
||||
</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:restriction base="xs:string">
|
||||
<xs:enumeration value="IMPLICIT"/>
|
||||
@@ -362,11 +355,13 @@
|
||||
|
||||
<xs:complexType name="userInfo">
|
||||
<xs:sequence>
|
||||
<!-- accountStatus potentially for future use -->
|
||||
<!-- Everything except userIdHashCode and nickname are for future use -->
|
||||
<xs:element name="userIdHashCode" type="xs:string" minOccurs="1"/>
|
||||
<xs:element name="accountTier" type="tns:userAccountTier" minOccurs="0"/>
|
||||
<xs:element name="accountType" type="tns:userAccountType" minOccurs="0"/>
|
||||
<xs:element name="accountStatus" type="tns:userAccountStatus" minOccurs="0"/>
|
||||
<xs:element 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:complexType>
|
||||
|
||||
@@ -893,10 +888,7 @@
|
||||
<xs:element name="getMediaURIResult" type="xs:anyURI"/>
|
||||
<xs:element name="deviceSessionToken" type="tns:deviceSessionToken" minOccurs="0" maxOccurs="1"/>
|
||||
<xs:element name="deviceSessionKey" type="tns:encryptionContext" minOccurs="0" maxOccurs="1"/>
|
||||
<xs:choice minOccurs="0">
|
||||
<xs:element name="contentKey" type="tns:encryptionContext" minOccurs="0" maxOccurs="1"/>
|
||||
<xs:element name="contentKeys" type="tns:contentKeys" minOccurs="0" maxOccurs="1"/>
|
||||
</xs:choice>
|
||||
<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="positionInformation" type="tns:positionInformation" minOccurs="0" maxOccurs="1"/>
|
||||
@@ -2067,7 +2059,7 @@
|
||||
|
||||
<wsdl:service name="Sonos">
|
||||
<wsdl:port name="SonosSoap" binding="tns:SonosSoap">
|
||||
<soap:address location="http://moapi.sonos.com/Test/TestService.php"/>
|
||||
<soap:address location="/about"/>
|
||||
</wsdl:port>
|
||||
</wsdl:service>
|
||||
|
||||
55
src/app.ts
@@ -4,12 +4,9 @@ import server from "./server";
|
||||
import logger from "./logger";
|
||||
|
||||
import {
|
||||
axiosImageFetcher,
|
||||
cachingImageFetcher,
|
||||
SubsonicMusicService,
|
||||
TranscodingCustomPlayers,
|
||||
NO_CUSTOM_PLAYERS,
|
||||
Subsonic
|
||||
appendMimeTypeToClientFor,
|
||||
DEFAULT,
|
||||
Subsonic,
|
||||
} from "./subsonic";
|
||||
import { InMemoryAPITokens, sha256 } from "./api_tokens";
|
||||
import { InMemoryLinkCodes } from "./link_codes";
|
||||
@@ -18,7 +15,7 @@ import sonos, { bonobService } from "./sonos";
|
||||
import { MusicService } from "./music_service";
|
||||
import { SystemClock } from "./clock";
|
||||
import { JWTSmapiLoginTokens } from "./smapi_auth";
|
||||
import { SQLiteSmapiTokenStore } from "./smapi_token_store";
|
||||
import { axiosImageFetcher, cachingImageFetcher } from "./images";
|
||||
|
||||
const config = readConfig();
|
||||
const clock = SystemClock;
|
||||
@@ -34,21 +31,19 @@ const bonob = bonobService(
|
||||
|
||||
const sonosSystem = sonos(config.sonos.discovery);
|
||||
|
||||
const customPlayers = config.subsonic.customClientsFor
|
||||
? TranscodingCustomPlayers.from(config.subsonic.customClientsFor)
|
||||
: NO_CUSTOM_PLAYERS;
|
||||
// todo: just pass in the customClientsForStringArray into subsonic and make it sort it out.
|
||||
const streamUserAgent = config.subsonic.customClientsFor
|
||||
? appendMimeTypeToClientFor(config.subsonic.customClientsFor.split(","))
|
||||
: DEFAULT;
|
||||
|
||||
const artistImageFetcher = config.subsonic.artistImageCache
|
||||
? cachingImageFetcher(config.subsonic.artistImageCache, axiosImageFetcher)
|
||||
: axiosImageFetcher;
|
||||
|
||||
const subsonic = new SubsonicMusicService(
|
||||
new Subsonic(
|
||||
const subsonic = new Subsonic(
|
||||
config.subsonic.url,
|
||||
customPlayers,
|
||||
streamUserAgent,
|
||||
artistImageFetcher
|
||||
),
|
||||
customPlayers
|
||||
);
|
||||
|
||||
const featureFlagAwareMusicService: MusicService = {
|
||||
@@ -82,16 +77,6 @@ const version = fs.existsSync(GIT_INFO)
|
||||
? fs.readFileSync(GIT_INFO).toString().trim()
|
||||
: "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(
|
||||
sonosSystem,
|
||||
bonob,
|
||||
@@ -103,16 +88,14 @@ const app = server(
|
||||
clock,
|
||||
iconColors: config.icons,
|
||||
applyContextPath: true,
|
||||
logRequests: config.logRequests,
|
||||
logRequests: true,
|
||||
version,
|
||||
smapiAuthTokens: new JWTSmapiLoginTokens(clock, config.secret, config.authTimeout),
|
||||
externalImageResolver: artistImageFetcher,
|
||||
smapiTokenStore,
|
||||
tokenCleanupIntervalMinutes: config.tokenStore.cleanupIntervalMinutes
|
||||
externalImageResolver: artistImageFetcher
|
||||
}
|
||||
);
|
||||
|
||||
const expressServer = app.listen(config.port, () => {
|
||||
app.listen(config.port, () => {
|
||||
logger.info(`Listening on ${config.port} available @ ${config.bonobUrl}`);
|
||||
});
|
||||
|
||||
@@ -130,16 +113,6 @@ if (config.sonos.autoRegister) {
|
||||
logger.info(`Found device ${d.name}(${d.group}) @ ${d.ip}:${d.port}`);
|
||||
});
|
||||
});
|
||||
};
|
||||
|
||||
process.on('SIGTERM', () => {
|
||||
logger.info('SIGTERM signal received: closing HTTP server');
|
||||
expressServer.close(() => {
|
||||
logger.info('HTTP server closed');
|
||||
});
|
||||
smapiTokenStore.close();
|
||||
process.exit(0);
|
||||
});
|
||||
|
||||
}
|
||||
|
||||
export default app;
|
||||
|
||||
10
src/burn.ts
@@ -1,8 +1,6 @@
|
||||
import _ from "underscore";
|
||||
import { createUrnUtil } from "urn-lib";
|
||||
import randomstring from "randomstring";
|
||||
import { pipe } from "fp-ts/lib/function";
|
||||
import { either as E } from "fp-ts";
|
||||
|
||||
import jwsEncryption from "./encryption";
|
||||
|
||||
@@ -80,13 +78,7 @@ export const parse = (burn: string): BUrn => {
|
||||
resource: result.resource as string,
|
||||
};
|
||||
if(x.system == "encrypted") {
|
||||
return pipe(
|
||||
encryptor.decrypt(x.resource),
|
||||
E.match(
|
||||
(err) => { throw new Error(err) },
|
||||
(z) => parse(z)
|
||||
)
|
||||
);
|
||||
return parse(encryptor.decrypt(x.resource));
|
||||
} else {
|
||||
return x;
|
||||
}
|
||||
|
||||
@@ -85,7 +85,6 @@ export default function () {
|
||||
validationPattern: COLOR,
|
||||
}),
|
||||
},
|
||||
logRequests: bnbEnvVar<boolean>("SERVER_LOG_REQUESTS", { default: false, parser: asBoolean }),
|
||||
sonos: {
|
||||
serviceName: bnbEnvVar<string>("SONOS_SERVICE_NAME", { default: "bonob" })!,
|
||||
discovery: {
|
||||
@@ -98,16 +97,12 @@ export default function () {
|
||||
sid: bnbEnvVar<number>("SONOS_SERVICE_ID", { default: 246, parser: asInt }),
|
||||
},
|
||||
subsonic: {
|
||||
url: url(bnbEnvVar("SUBSONIC_URL", { legacy: ["BONOB_NAVIDROME_URL"], default: `http://${hostname()}:4533` })!),
|
||||
url: bnbEnvVar("SUBSONIC_URL", { legacy: ["BONOB_NAVIDROME_URL"], default: `http://${hostname()}:4533` })!,
|
||||
customClientsFor: bnbEnvVar<string>("SUBSONIC_CUSTOM_CLIENTS", { legacy: ["BONOB_NAVIDROME_CUSTOM_CLIENTS"] }),
|
||||
artistImageCache: bnbEnvVar<string>("SUBSONIC_ARTIST_IMAGE_CACHE"),
|
||||
},
|
||||
scrobbleTracks: bnbEnvVar<boolean>("SCROBBLE_TRACKS", { default: true, parser: asBoolean }),
|
||||
reportNowPlaying:
|
||||
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 })!,
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
@@ -4,14 +4,13 @@ import {
|
||||
randomBytes,
|
||||
createHash,
|
||||
} 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";
|
||||
|
||||
const ALGORITHM = "aes-256-cbc";
|
||||
const IV = randomBytes(16);
|
||||
|
||||
|
||||
export type Hash = {
|
||||
iv: string;
|
||||
encryptedData: string;
|
||||
@@ -19,7 +18,7 @@ export type Hash = {
|
||||
|
||||
export type Encryption = {
|
||||
encrypt: (value: string) => string;
|
||||
decrypt: (value: string) => Either<string, string>;
|
||||
decrypt: (value: string) => string;
|
||||
};
|
||||
|
||||
export const jwsEncryption = (secret: string): Encryption => {
|
||||
@@ -29,15 +28,7 @@ export const jwsEncryption = (secret: string): Encryption => {
|
||||
payload: value,
|
||||
secret: secret,
|
||||
}),
|
||||
decrypt: (value: string) => pipe(
|
||||
jws.decode(value),
|
||||
O.fromNullable,
|
||||
O.map(it => it.payload),
|
||||
O.match(
|
||||
() => left("Failed to decrypt jws"),
|
||||
(payload) => right(payload)
|
||||
)
|
||||
)
|
||||
decrypt: (value: string) => jws.decode(value).payload
|
||||
}
|
||||
}
|
||||
|
||||
@@ -45,8 +36,7 @@ export const cryptoEncryption = (secret: string): Encryption => {
|
||||
const key = createHash("sha256")
|
||||
.update(String(secret))
|
||||
.digest("base64")
|
||||
.substring(0, 32);
|
||||
|
||||
.substr(0, 32);
|
||||
return {
|
||||
encrypt: (value: string) => {
|
||||
const cipher = createCipheriv(ALGORITHM, key, IV);
|
||||
@@ -55,23 +45,20 @@ export const cryptoEncryption = (secret: string): Encryption => {
|
||||
cipher.final(),
|
||||
]).toString("hex")}`;
|
||||
},
|
||||
decrypt: (value: string) => pipe(
|
||||
right(value),
|
||||
E.map(it => it.split(".")),
|
||||
E.flatMap(it => it.length == 2 ? right({ iv: it[0]!, data: it[1]! }) : left("Invalid value to decrypt")),
|
||||
E.map(it => ({
|
||||
hash: it,
|
||||
decipher: createDecipheriv(
|
||||
decrypt: (value: string) => {
|
||||
const parts = value.split(".");
|
||||
if(parts.length != 2) throw `Invalid value to decrypt`;
|
||||
|
||||
const decipher = createDecipheriv(
|
||||
ALGORITHM,
|
||||
key,
|
||||
Buffer.from(it.iv, "hex")
|
||||
)
|
||||
})),
|
||||
E.map(it => Buffer.concat([
|
||||
it.decipher.update(Buffer.from(it.hash.data, "hex")),
|
||||
it.decipher.final(),
|
||||
]).toString())
|
||||
),
|
||||
Buffer.from(parts[0]!, "hex")
|
||||
);
|
||||
return Buffer.concat([
|
||||
decipher.update(Buffer.from(parts[1]!, "hex")),
|
||||
decipher.final(),
|
||||
]).toString();
|
||||
},
|
||||
};
|
||||
};
|
||||
|
||||
|
||||
67
src/http.ts
Normal file
@@ -0,0 +1,67 @@
|
||||
import {
|
||||
AxiosPromise,
|
||||
AxiosRequestConfig,
|
||||
Method,
|
||||
ResponseType,
|
||||
} from "axios";
|
||||
|
||||
// todo: do i need this anymore?
|
||||
export interface Http {
|
||||
(config: AxiosRequestConfig): AxiosPromise<any>;
|
||||
}
|
||||
export interface Http2 extends Http {
|
||||
with: (params: Partial<RequestParams>) => Http2;
|
||||
}
|
||||
|
||||
export type RequestParams = {
|
||||
baseURL: string;
|
||||
url: string;
|
||||
params: any;
|
||||
headers: any;
|
||||
responseType: ResponseType;
|
||||
method: Method;
|
||||
};
|
||||
|
||||
const wrap = (http2: Http2, params: Partial<RequestParams>): Http2 => {
|
||||
const f = ((config: AxiosRequestConfig) => http2(merge(params, config))) as Http2;
|
||||
f.with = (params: Partial<RequestParams>) => wrap(f, params);
|
||||
return f;
|
||||
};
|
||||
|
||||
export const http2From = (http: Http): Http2 => {
|
||||
const f = ((config: AxiosRequestConfig) => http(config)) as Http2;
|
||||
f.with = (defaults: Partial<RequestParams>) => wrap(f, defaults);
|
||||
return f;
|
||||
}
|
||||
|
||||
const merge = (
|
||||
defaults: Partial<RequestParams>,
|
||||
config: AxiosRequestConfig
|
||||
) => {
|
||||
let toApply = {
|
||||
...defaults,
|
||||
...config,
|
||||
};
|
||||
if (defaults.params) {
|
||||
toApply = {
|
||||
...toApply,
|
||||
params: {
|
||||
...defaults.params,
|
||||
...config.params,
|
||||
},
|
||||
};
|
||||
}
|
||||
if (defaults.headers) {
|
||||
toApply = {
|
||||
...toApply,
|
||||
headers: {
|
||||
...defaults.headers,
|
||||
...config.headers,
|
||||
},
|
||||
};
|
||||
}
|
||||
return toApply;
|
||||
};
|
||||
|
||||
export const http =
|
||||
(base: Http, defaults: Partial<RequestParams>): Http => (config: AxiosRequestConfig) => base(merge(defaults, config));
|
||||
94
src/i8n.ts
@@ -4,12 +4,11 @@ import { option as O } from "fp-ts";
|
||||
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 SUPPORTED_LANG = "en-US" | "da-DK" | "fr-FR" | "nl-NL";
|
||||
export type SUPPORTED_LANG = "en-US" | "nl-NL";
|
||||
export type KEY =
|
||||
| "AppLinkMessage"
|
||||
| "artists"
|
||||
| "albums"
|
||||
| "internetRadio"
|
||||
| "playlists"
|
||||
| "genres"
|
||||
| "random"
|
||||
@@ -40,7 +39,6 @@ export type KEY =
|
||||
| "loginFailed"
|
||||
| "noSonosDevices"
|
||||
| "favourites"
|
||||
| "years"
|
||||
| "LOVE"
|
||||
| "LOVE_SUCCESS"
|
||||
| "STAR"
|
||||
@@ -53,7 +51,6 @@ const translations: Record<SUPPORTED_LANG, Record<KEY, string>> = {
|
||||
AppLinkMessage: "Linking sonos with $BNB_SONOS_SERVICE_NAME",
|
||||
artists: "Artists",
|
||||
albums: "Albums",
|
||||
internetRadio: "Internet Radio",
|
||||
tracks: "Tracks",
|
||||
playlists: "Playlists",
|
||||
genres: "Genres",
|
||||
@@ -84,7 +81,6 @@ const translations: Record<SUPPORTED_LANG, Record<KEY, string>> = {
|
||||
loginFailed: "Login failed!",
|
||||
noSonosDevices: "No sonos devices",
|
||||
favourites: "Favourites",
|
||||
years: "Years",
|
||||
STAR: "Star",
|
||||
UNSTAR: "Un-star",
|
||||
STAR_SUCCESS: "Track starred",
|
||||
@@ -92,97 +88,10 @@ const translations: Record<SUPPORTED_LANG, Record<KEY, string>> = {
|
||||
LOVE: "Love",
|
||||
LOVE_SUCCESS: "Track loved"
|
||||
},
|
||||
"da-DK": {
|
||||
AppLinkMessage: "Forbinder Sonos med $BNB_SONOS_SERVICE_NAME",
|
||||
artists: "Kunstnere",
|
||||
albums: "Album",
|
||||
internetRadio: "Internet Radio",
|
||||
tracks: "Numre",
|
||||
playlists: "Afspilningslister",
|
||||
genres: "Genre",
|
||||
random: "Tilfældig",
|
||||
topRated: "Højst vurderet",
|
||||
recentlyAdded: "Senest tilføjet",
|
||||
recentlyPlayed: "Senest afspillet",
|
||||
mostPlayed: "Flest afspilninger",
|
||||
success: "Succes",
|
||||
failure: "Fejl",
|
||||
expectedConfig: "Forventet konfiguration",
|
||||
existingServiceConfig: "Eksisterende tjeneste konfiguration",
|
||||
noExistingServiceRegistration: "Ingen eksisterende tjeneste registrering",
|
||||
register: "Registrer",
|
||||
removeRegistration: "Fjern registrering",
|
||||
devices: "Enheder",
|
||||
services: "Tjenester",
|
||||
login: "Log på",
|
||||
logInToBonob: "Log på $BNB_SONOS_SERVICE_NAME",
|
||||
username: "Brugernavn",
|
||||
password: "Adgangskode",
|
||||
successfullyRegistered: "Registreret med succes",
|
||||
registrationFailed: "Registrering fejlede!",
|
||||
successfullyRemovedRegistration: "Registrering fjernet med succes",
|
||||
failedToRemoveRegistration: "FJernelse af registrering fejlede!",
|
||||
invalidLinkCode: "Ugyldig linkCode!",
|
||||
loginSuccessful: "Log på succes!",
|
||||
loginFailed: "Log på fejlede!",
|
||||
noSonosDevices: "Ingen Sonos enheder",
|
||||
favourites: "Favoritter",
|
||||
years: "Flere år",
|
||||
STAR: "Tilføj stjerne",
|
||||
UNSTAR: "Fjern stjerne",
|
||||
STAR_SUCCESS: "Stjerne tilføjet",
|
||||
UNSTAR_SUCCESS: "Stjerne fjernet",
|
||||
LOVE: "Synes godt om",
|
||||
LOVE_SUCCESS: "Syntes godt om"
|
||||
},
|
||||
"fr-FR": {
|
||||
AppLinkMessage: "Associer Sonos à $BNB_SONOS_SERVICE_NAME",
|
||||
artists: "Artistes",
|
||||
albums: "Albums",
|
||||
internetRadio: "Radio Internet",
|
||||
tracks: "Pistes",
|
||||
playlists: "Playlists",
|
||||
genres: "Genres",
|
||||
random: "Aléatoire",
|
||||
topRated: "Les mieux notés",
|
||||
recentlyAdded: "Récemment ajouté",
|
||||
recentlyPlayed: "Récemment joué",
|
||||
mostPlayed: "Les plus joué",
|
||||
success: "Succès",
|
||||
failure: "Échec",
|
||||
expectedConfig: "Configuration attendue",
|
||||
existingServiceConfig: "La configuration de service existe",
|
||||
noExistingServiceRegistration: "Aucun enregistrement de service existant",
|
||||
register: "Inscription",
|
||||
removeRegistration: "Supprimer l'inscription",
|
||||
devices: "Appareils",
|
||||
services: "Services",
|
||||
login: "Se connecter",
|
||||
logInToBonob: "Se connecter à $BNB_SONOS_SERVICE_NAME",
|
||||
username: "Nom d'utilisateur",
|
||||
password: "Mot de passe",
|
||||
successfullyRegistered: "Connecté avec succès",
|
||||
registrationFailed: "Échec de la connexion !",
|
||||
successfullyRemovedRegistration: "Inscription supprimée avec succès",
|
||||
failedToRemoveRegistration: "Échec de la suppression de l'inscription !",
|
||||
invalidLinkCode: "Code non valide !",
|
||||
loginSuccessful: "Connexion réussie !",
|
||||
loginFailed: "La connexion a échoué !",
|
||||
noSonosDevices: "Aucun appareil Sonos",
|
||||
favourites: "Favoris",
|
||||
years: "Années",
|
||||
STAR: "Suivre",
|
||||
UNSTAR: "Ne plus suivre",
|
||||
STAR_SUCCESS: "Piste suivie",
|
||||
UNSTAR_SUCCESS: "Piste non suivie",
|
||||
LOVE: "Aimer",
|
||||
LOVE_SUCCESS: "Pistes aimée"
|
||||
},
|
||||
"nl-NL": {
|
||||
AppLinkMessage: "Sonos koppelen aan $BNB_SONOS_SERVICE_NAME",
|
||||
artists: "Artiesten",
|
||||
albums: "Albums",
|
||||
internetRadio: "Internet Radio",
|
||||
tracks: "Nummers",
|
||||
playlists: "Afspeellijsten",
|
||||
genres: "Genres",
|
||||
@@ -213,7 +122,6 @@ const translations: Record<SUPPORTED_LANG, Record<KEY, string>> = {
|
||||
loginFailed: "Inloggen mislukt!",
|
||||
noSonosDevices: "Geen Sonos-apparaten",
|
||||
favourites: "Favorieten",
|
||||
years: "Jaren",
|
||||
STAR: "Ster ",
|
||||
UNSTAR: "Een ster",
|
||||
STAR_SUCCESS: "Nummer met ster",
|
||||
|
||||
96
src/icon.ts
@@ -1,5 +1,4 @@
|
||||
import * as xpath from "xpath";
|
||||
import { DOMParser, Node } from '@xmldom/xmldom';
|
||||
import libxmljs, { Element, Attribute } from "libxmljs2";
|
||||
import _ from "underscore";
|
||||
import fs from "fs";
|
||||
|
||||
@@ -14,10 +13,11 @@ import {
|
||||
isMay4,
|
||||
SystemClock,
|
||||
} from "./clock";
|
||||
import { xmlTidy } from "./utils";
|
||||
import path from "path";
|
||||
|
||||
const SVG_NS = "http://www.w3.org/2000/svg";
|
||||
const SVG_NS = {
|
||||
svg: "http://www.w3.org/2000/svg",
|
||||
};
|
||||
|
||||
class ViewBox {
|
||||
minX: number;
|
||||
@@ -48,16 +48,8 @@ export type IconFeatures = {
|
||||
viewPortIncreasePercent: number | undefined;
|
||||
backgroundColor: string | undefined;
|
||||
foregroundColor: string | undefined;
|
||||
text: string | undefined;
|
||||
};
|
||||
|
||||
export const NO_FEATURES: IconFeatures = {
|
||||
viewPortIncreasePercent: undefined,
|
||||
backgroundColor: undefined,
|
||||
foregroundColor: undefined,
|
||||
text: undefined
|
||||
}
|
||||
|
||||
export type IconSpec = {
|
||||
svg: string | undefined;
|
||||
features: Partial<IconFeatures> | undefined;
|
||||
@@ -101,11 +93,17 @@ export class SvgIcon implements Icon {
|
||||
|
||||
constructor(
|
||||
svg: string,
|
||||
features: Partial<IconFeatures> = {}
|
||||
features: Partial<IconFeatures> = {
|
||||
viewPortIncreasePercent: undefined,
|
||||
backgroundColor: undefined,
|
||||
foregroundColor: undefined,
|
||||
}
|
||||
) {
|
||||
this.svg = svg;
|
||||
this.features = {
|
||||
...NO_FEATURES,
|
||||
viewPortIncreasePercent: undefined,
|
||||
backgroundColor: undefined,
|
||||
foregroundColor: undefined,
|
||||
...features,
|
||||
};
|
||||
}
|
||||
@@ -119,44 +117,38 @@ export class SvgIcon implements Icon {
|
||||
});
|
||||
|
||||
public toString = () => {
|
||||
const doc = new DOMParser().parseFromString(this.svg, 'text/xml') as unknown as Document;
|
||||
const select = xpath.useNamespaces({ svg: SVG_NS });
|
||||
|
||||
const elements = (path: string) => (select(path, doc) as Element[])
|
||||
const element = (path: string) => elements(path)[0]!
|
||||
|
||||
let viewBox = new ViewBox(select("string(//svg:svg/@viewBox)", doc) as string);
|
||||
const xml = libxmljs.parseXmlString(this.svg, {
|
||||
noblanks: true,
|
||||
net: false,
|
||||
});
|
||||
const viewBoxAttr = xml.get("//svg:svg/@viewBox", SVG_NS) as Attribute;
|
||||
let viewBox = new ViewBox(viewBoxAttr.value());
|
||||
if (
|
||||
this.features.viewPortIncreasePercent &&
|
||||
this.features.viewPortIncreasePercent > 0
|
||||
) {
|
||||
viewBox = viewBox.increasePercent(this.features.viewPortIncreasePercent);
|
||||
element("//svg:svg").setAttribute("viewBox", viewBox.toString());
|
||||
}
|
||||
if(this.features.text) {
|
||||
elements("//svg:text").forEach((text) => {
|
||||
text.textContent = this.features.text!
|
||||
});
|
||||
}
|
||||
if (this.features.foregroundColor) {
|
||||
elements("//svg:path|//svg:text").forEach((path) => {
|
||||
if (path.getAttribute("fill")) path.setAttribute("stroke", this.features.foregroundColor!);
|
||||
else path.setAttribute("fill", this.features.foregroundColor!);
|
||||
});
|
||||
viewBoxAttr.value(viewBox.toString());
|
||||
}
|
||||
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]!);
|
||||
(xml.get("//svg:svg/*[1]", SVG_NS) as Element).addPrevSibling(
|
||||
new Element(xml, "rect").attr({
|
||||
x: `${viewBox.minX}`,
|
||||
y: `${viewBox.minY}`,
|
||||
width: `${Math.abs(viewBox.minX) + viewBox.width}`,
|
||||
height: `${Math.abs(viewBox.minY) + viewBox.height}`,
|
||||
fill: this.features.backgroundColor,
|
||||
})
|
||||
);
|
||||
}
|
||||
|
||||
return xmlTidy(doc as unknown as Node);
|
||||
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();
|
||||
};
|
||||
}
|
||||
|
||||
@@ -171,7 +163,6 @@ export const HOLI_COLORS = [
|
||||
export type ICON =
|
||||
| "artists"
|
||||
| "albums"
|
||||
| "radio"
|
||||
| "playlists"
|
||||
| "genres"
|
||||
| "random"
|
||||
@@ -237,24 +228,19 @@ export type ICON =
|
||||
| "yoda"
|
||||
| "heart"
|
||||
| "star"
|
||||
| "solidStar"
|
||||
| "yy"
|
||||
| "yyyy";
|
||||
| "solidStar";
|
||||
|
||||
const svgFrom = (name: string) =>
|
||||
const iconFrom = (name: string) =>
|
||||
new SvgIcon(
|
||||
fs
|
||||
.readFileSync(path.resolve(__dirname, "..", "web", "icons", name))
|
||||
.toString()
|
||||
);
|
||||
|
||||
const iconFrom = (name: string) => svgFrom(name).with({ features: { viewPortIncreasePercent: 80 } });
|
||||
|
||||
export const ICONS: Record<ICON, SvgIcon> = {
|
||||
artists: iconFrom("navidrome-artists.svg"),
|
||||
albums: iconFrom("navidrome-all.svg"),
|
||||
radio: iconFrom("navidrome-radio.svg"),
|
||||
blank: svgFrom("blank.svg"),
|
||||
blank: iconFrom("blank.svg"),
|
||||
playlists: iconFrom("navidrome-playlists.svg"),
|
||||
genres: iconFrom("Theatre-Mask-111172.svg"),
|
||||
random: iconFrom("navidrome-random.svg"),
|
||||
@@ -319,9 +305,7 @@ export const ICONS: Record<ICON, SvgIcon> = {
|
||||
yoda: iconFrom("Yoda-68107.svg"),
|
||||
heart: iconFrom("Heart-85038.svg"),
|
||||
star: iconFrom("Star-16101.svg"),
|
||||
solidStar: iconFrom("Star-43879.svg"),
|
||||
yy: svgFrom("yy.svg"),
|
||||
yyyy: svgFrom("yyyy.svg"),
|
||||
solidStar: iconFrom("Star-43879.svg")
|
||||
};
|
||||
|
||||
export const STAR_WARS = [ICONS.c3po, ICONS.chewy, ICONS.darth, ICONS.skywalker, ICONS.leia, ICONS.r2d2, ICONS.yoda];
|
||||
|
||||
48
src/images.ts
Normal file
@@ -0,0 +1,48 @@
|
||||
|
||||
import sharp from "sharp";
|
||||
import fse from "fs-extra";
|
||||
import path from "path";
|
||||
import { Md5 } from "ts-md5/dist/md5";
|
||||
import axios from "axios";
|
||||
|
||||
import { CoverArt } from "./music_service";
|
||||
import { BROWSER_HEADERS } from "./utils";
|
||||
|
||||
export type ImageFetcher = (url: string) => Promise<CoverArt | undefined>;
|
||||
|
||||
export const cachingImageFetcher =
|
||||
(cacheDir: string, delegate: ImageFetcher) =>
|
||||
async (url: string): Promise<CoverArt | undefined> => {
|
||||
const filename = path.join(cacheDir, `${Md5.hashStr(url)}.png`);
|
||||
return fse
|
||||
.readFile(filename)
|
||||
.then((data) => ({ contentType: "image/png", data }))
|
||||
.catch(() =>
|
||||
delegate(url).then((image) => {
|
||||
if (image) {
|
||||
return sharp(image.data)
|
||||
.png()
|
||||
.toBuffer()
|
||||
.then((png) => {
|
||||
return fse
|
||||
.writeFile(filename, png)
|
||||
.then(() => ({ contentType: "image/png", data: png }));
|
||||
});
|
||||
} else {
|
||||
return undefined;
|
||||
}
|
||||
})
|
||||
);
|
||||
};
|
||||
|
||||
export const axiosImageFetcher = (url: string): Promise<CoverArt | undefined> =>
|
||||
axios
|
||||
.get(url, {
|
||||
headers: BROWSER_HEADERS,
|
||||
responseType: "arraybuffer",
|
||||
})
|
||||
.then((res) => ({
|
||||
contentType: res.headers["content-type"],
|
||||
data: Buffer.from(res.data, "binary"),
|
||||
}))
|
||||
.catch(() => undefined);
|
||||
@@ -6,7 +6,7 @@ export function debugIt<T>(thing: T): T {
|
||||
}
|
||||
|
||||
const logger = createLogger({
|
||||
level: process.env["BNB_LOG_LEVEL"] || 'info',
|
||||
level: 'debug',
|
||||
format: format.combine(
|
||||
format.timestamp({
|
||||
format: 'YYYY-MM-DD HH:mm:ss'
|
||||
|
||||
@@ -15,7 +15,13 @@ export class AuthFailure extends Error {
|
||||
}
|
||||
};
|
||||
|
||||
export type IdName = {
|
||||
id: string;
|
||||
name: string;
|
||||
};
|
||||
|
||||
export type ArtistSummary = {
|
||||
// todo: why can this be undefined?
|
||||
id: string | undefined;
|
||||
name: string;
|
||||
image: BUrn | undefined;
|
||||
@@ -46,24 +52,15 @@ export type Genre = {
|
||||
id: string;
|
||||
}
|
||||
|
||||
export type Year = {
|
||||
year: string;
|
||||
}
|
||||
|
||||
export type Rating = {
|
||||
love: boolean;
|
||||
stars: number;
|
||||
}
|
||||
|
||||
export type Encoding = {
|
||||
player: string,
|
||||
mimeType: string
|
||||
}
|
||||
|
||||
export type Track = {
|
||||
id: string;
|
||||
name: string;
|
||||
encoding: Encoding,
|
||||
mimeType: string;
|
||||
duration: number;
|
||||
number: number | undefined;
|
||||
genre: Genre | undefined;
|
||||
@@ -73,16 +70,9 @@ export type Track = {
|
||||
rating: Rating;
|
||||
};
|
||||
|
||||
export type RadioStation = {
|
||||
id: string,
|
||||
name: string,
|
||||
url: string,
|
||||
homePage?: string
|
||||
}
|
||||
|
||||
export type Paging = {
|
||||
_index: number;
|
||||
_count: number;
|
||||
_index: number | undefined;
|
||||
_count: number | undefined;
|
||||
};
|
||||
|
||||
export type Result<T> = {
|
||||
@@ -90,9 +80,10 @@ export type Result<T> = {
|
||||
total: number;
|
||||
};
|
||||
|
||||
export function slice2<T>({ _index, _count }: Paging) {
|
||||
export function slice2<T>({ _index, _count }: Partial<Paging> = {}) {
|
||||
const i = _index || 0;
|
||||
return (things: T[]): [T[], number] => [
|
||||
things.slice(_index, _index + _count),
|
||||
_count ? things.slice(i, i + _count) : things.slice(i),
|
||||
things.length,
|
||||
];
|
||||
}
|
||||
@@ -104,13 +95,11 @@ export const asResult = <T>([results, total]: [T[], number]) => ({
|
||||
|
||||
export type ArtistQuery = Paging;
|
||||
|
||||
export type AlbumQueryType = 'alphabeticalByArtist' | 'alphabeticalByName' | 'byGenre' | 'byYear' | 'random' | 'recentlyPlayed' | 'mostPlayed' | 'recentlyAdded' | 'favourited' | 'starred';
|
||||
export type AlbumQueryType = 'alphabeticalByArtist' | 'alphabeticalByName' | 'byGenre' | 'random' | 'recentlyPlayed' | 'mostPlayed' | 'recentlyAdded' | 'favourited' | 'starred';
|
||||
|
||||
export type AlbumQuery = Paging & {
|
||||
type: AlbumQueryType;
|
||||
genre?: string;
|
||||
fromYear?: string;
|
||||
toYear?: string;
|
||||
};
|
||||
|
||||
export const artistToArtistSummary = (it: Artist): ArtistSummary => ({
|
||||
@@ -131,8 +120,7 @@ export const albumToAlbumSummary = (it: Album): AlbumSummary => ({
|
||||
|
||||
export const playlistToPlaylistSummary = (it: Playlist): PlaylistSummary => ({
|
||||
id: it.id,
|
||||
name: it.name,
|
||||
coverArt: it.coverArt
|
||||
name: it.name
|
||||
})
|
||||
|
||||
export type StreamingHeader = "content-type" | "content-length" | "content-range" | "accept-ranges";
|
||||
@@ -150,14 +138,17 @@ export type CoverArt = {
|
||||
|
||||
export type PlaylistSummary = {
|
||||
id: string,
|
||||
name: string,
|
||||
coverArt?: BUrn | undefined
|
||||
name: string
|
||||
}
|
||||
|
||||
export type Playlist = PlaylistSummary & {
|
||||
entries: Track[]
|
||||
}
|
||||
|
||||
export type Sortable = {
|
||||
sortName: string
|
||||
}
|
||||
|
||||
export const range = (size: number) => [...Array(size).keys()];
|
||||
|
||||
export const asArtistAlbumPairs = (artists: Artist[]): [Artist, Album][] =>
|
||||
@@ -172,14 +163,13 @@ export interface MusicService {
|
||||
}
|
||||
|
||||
export interface MusicLibrary {
|
||||
artists(q: ArtistQuery): Promise<Result<ArtistSummary>>;
|
||||
artists(q: ArtistQuery): Promise<Result<ArtistSummary & Sortable>>;
|
||||
artist(id: string): Promise<Artist>;
|
||||
albums(q: AlbumQuery): Promise<Result<AlbumSummary>>;
|
||||
album(id: string): Promise<Album>;
|
||||
tracks(albumId: string): Promise<Track[]>;
|
||||
track(trackId: string): Promise<Track>;
|
||||
genres(): Promise<Genre[]>;
|
||||
years(): Promise<Year[]>;
|
||||
stream({
|
||||
trackId,
|
||||
range,
|
||||
@@ -202,6 +192,4 @@ export interface MusicLibrary {
|
||||
removeFromPlaylist(playlistId: string, indicies: number[]): Promise<boolean>
|
||||
similarSongs(id: string): Promise<Track[]>;
|
||||
topSongs(artistId: string): Promise<Track[]>;
|
||||
radioStation(id: string): Promise<RadioStation>
|
||||
radioStations(): Promise<RadioStation[]>
|
||||
}
|
||||
|
||||
273
src/server.ts
@@ -31,37 +31,15 @@ import { pipe } from "fp-ts/lib/function";
|
||||
import { URLBuilder } from "./url_builder";
|
||||
import makeI8N, { asLANGs, KEY, keys as i8nKeys, LANG } from "./i8n";
|
||||
import { Icon, ICONS, festivals, features } from "./icon";
|
||||
import _ from "underscore";
|
||||
import _, { shuffle } from "underscore";
|
||||
import morgan from "morgan";
|
||||
import { mask, takeWithRepeats } from "./utils";
|
||||
import { parse } from "./burn";
|
||||
import { axiosImageFetcher, ImageFetcher } from "./subsonic";
|
||||
import {
|
||||
JWTSmapiLoginTokens,
|
||||
SmapiAuthTokens,
|
||||
} from "./smapi_auth";
|
||||
import { SmapiTokenStore, InMemorySmapiTokenStore } from "./smapi_token_store";
|
||||
import { axiosImageFetcher, ImageFetcher } from "./images";
|
||||
import { JWTSmapiLoginTokens, SmapiAuthTokens } from "./smapi_auth";
|
||||
|
||||
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 {
|
||||
range: (length: number) => string;
|
||||
}
|
||||
@@ -112,8 +90,6 @@ export type ServerOpts = {
|
||||
version: string;
|
||||
smapiAuthTokens: SmapiAuthTokens;
|
||||
externalImageResolver: ImageFetcher;
|
||||
smapiTokenStore: SmapiTokenStore;
|
||||
tokenCleanupIntervalMinutes: number;
|
||||
};
|
||||
|
||||
const DEFAULT_SERVER_OPTS: ServerOpts = {
|
||||
@@ -130,8 +106,6 @@ const DEFAULT_SERVER_OPTS: ServerOpts = {
|
||||
"1m"
|
||||
),
|
||||
externalImageResolver: axiosImageFetcher,
|
||||
smapiTokenStore: new InMemorySmapiTokenStore(),
|
||||
tokenCleanupIntervalMinutes: 60,
|
||||
};
|
||||
|
||||
function server(
|
||||
@@ -157,7 +131,6 @@ function server(
|
||||
app.use(morgan("combined"));
|
||||
}
|
||||
app.use(express.urlencoded({ extended: false }));
|
||||
app.use(express.json());
|
||||
|
||||
app.use(express.static(path.resolve(__dirname, "..", "web", "public")));
|
||||
app.engine("eta", Eta.renderFile);
|
||||
@@ -398,38 +371,35 @@ function server(
|
||||
const id = req.params["id"]!;
|
||||
const trace = uuid();
|
||||
|
||||
logger.debug(
|
||||
logger.info(
|
||||
`${trace} bnb<- ${req.method} ${req.path}?${JSON.stringify(
|
||||
req.query
|
||||
)}, headers=${JSON.stringify({ ...req.headers, "bnbt": "*****", "bnbk": "*****" })}`
|
||||
)}, headers=${JSON.stringify(mask(req.headers, ["bnbt", "bnbk"]))}`
|
||||
);
|
||||
|
||||
const serviceToken = pipe(
|
||||
E.fromNullable("Missing bnbt header")(req.headers["bnbt"] as string),
|
||||
E.chain(token => pipe(
|
||||
E.chain((token) =>
|
||||
pipe(
|
||||
E.fromNullable("Missing bnbk header")(req.headers["bnbk"] as string),
|
||||
E.map(key => ({ token, key }))
|
||||
)),
|
||||
E.map((key) => ({ token, key }))
|
||||
)
|
||||
),
|
||||
E.chain((auth) =>
|
||||
pipe(
|
||||
smapiAuthTokens.verify(auth),
|
||||
E.mapLeft((_) => "Auth token failed to verify")
|
||||
)
|
||||
),
|
||||
E.getOrElseW(() => undefined)
|
||||
)
|
||||
E.getOrElseW((e: string) => {
|
||||
logger.error(`Failed to get serviceToken for stream: ${e}`);
|
||||
return undefined;
|
||||
})
|
||||
);
|
||||
|
||||
if (!serviceToken) {
|
||||
return res.status(401).send();
|
||||
} 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
|
||||
.login(serviceToken)
|
||||
.then((it) =>
|
||||
@@ -438,17 +408,13 @@ function server(
|
||||
trackId: id,
|
||||
range: req.headers["range"] || undefined,
|
||||
})
|
||||
.then((stream) => {
|
||||
res.on('close', () => {
|
||||
stream.stream.destroy()
|
||||
});
|
||||
return stream;
|
||||
})
|
||||
.then((stream) => ({ musicLibrary: it, stream }))
|
||||
)
|
||||
.then(({ musicLibrary, stream }) => {
|
||||
logger.debug(
|
||||
`${trace} bnb<- stream response from music service for ${id}, status=${stream.status}, headers=(${JSON.stringify(stream.headers)})`
|
||||
logger.info(
|
||||
`${trace} bnb<- stream response from music service for ${id}, status=${
|
||||
stream.status
|
||||
}, headers=(${JSON.stringify(stream.headers)})`
|
||||
);
|
||||
|
||||
const sonosisfyContentType = (contentType: string) =>
|
||||
@@ -471,8 +437,10 @@ function server(
|
||||
sendStream: boolean;
|
||||
nowPlaying: boolean;
|
||||
}) => {
|
||||
logger.debug(
|
||||
`${trace} bnb-> ${req.path}, status=${status}, headers=${JSON.stringify(headers)}`
|
||||
logger.info(
|
||||
`${trace} bnb-> ${
|
||||
req.path
|
||||
}, status=${status}, headers=${JSON.stringify(headers)}`
|
||||
);
|
||||
(nowPlaying
|
||||
? musicLibrary.nowPlaying(id)
|
||||
@@ -484,8 +452,8 @@ function server(
|
||||
.forEach(([header, value]) => {
|
||||
res.setHeader(header, value!);
|
||||
});
|
||||
if (sendStream) stream.stream.pipe(filter).pipe(res)
|
||||
else res.send()
|
||||
if (sendStream) stream.stream.pipe(filter).pipe(res);
|
||||
else res.send();
|
||||
});
|
||||
};
|
||||
|
||||
@@ -531,18 +499,16 @@ function server(
|
||||
}
|
||||
});
|
||||
|
||||
app.get("/icon/:type_text/size/:size", (req, res) => {
|
||||
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]
|
||||
app.get("/icon/:type/size/:size", (req, res) => {
|
||||
const type = req.params["type"]!;
|
||||
const size = req.params["size"]!;
|
||||
|
||||
if (!Object.keys(ICONS).includes(type)) {
|
||||
return res.status(404).send();
|
||||
} else if (size != "legacy" && !SONOS_RECOMMENDED_IMAGE_SIZES.includes(size)) {
|
||||
} else if (
|
||||
size != "legacy" &&
|
||||
!SONOS_RECOMMENDED_IMAGE_SIZES.includes(size)
|
||||
) {
|
||||
return res.status(400).send();
|
||||
} else {
|
||||
let icon = (ICONS as any)[type]! as Icon;
|
||||
@@ -563,8 +529,8 @@ function server(
|
||||
icon
|
||||
.apply(
|
||||
features({
|
||||
viewPortIncreasePercent: 80,
|
||||
...serverOpts.iconColors,
|
||||
text: text
|
||||
})
|
||||
)
|
||||
.apply(festivals(clock))
|
||||
@@ -592,11 +558,23 @@ function server(
|
||||
});
|
||||
});
|
||||
|
||||
app.get("/art/:burn/size/:size", (req, res) => {
|
||||
const GRAVITY_9 = [
|
||||
"north",
|
||||
"northeast",
|
||||
"east",
|
||||
"southeast",
|
||||
"south",
|
||||
"southwest",
|
||||
"west",
|
||||
"northwest",
|
||||
"centre",
|
||||
];
|
||||
|
||||
app.get("/art/:burns/size/:size", (req, res) => {
|
||||
const serviceToken = apiTokens.authTokenFor(
|
||||
req.query[BONOB_ACCESS_TOKEN_HEADER] as string
|
||||
);
|
||||
const urn = parse(req.params["burn"]!);
|
||||
const urns = req.params["burns"]!.split("&").map(parse);
|
||||
const size = Number.parseInt(req.params["size"]!);
|
||||
|
||||
if (!serviceToken) {
|
||||
@@ -607,137 +585,61 @@ function server(
|
||||
|
||||
return musicService
|
||||
.login(serviceToken)
|
||||
.then((musicLibrary) => {
|
||||
if (urn.system == "external") {
|
||||
return serverOpts.externalImageResolver(urn.resource);
|
||||
.then((musicLibrary) =>
|
||||
Promise.all(
|
||||
urns.map((it) => {
|
||||
if (it.system == "external") {
|
||||
return serverOpts.externalImageResolver(it.resource);
|
||||
} else {
|
||||
return musicLibrary.coverArt(urn, size);
|
||||
return musicLibrary.coverArt(it, size);
|
||||
}
|
||||
})
|
||||
.then((coverArt) => {
|
||||
if(coverArt) {
|
||||
)
|
||||
)
|
||||
.then((coverArts) => coverArts.filter((it) => it))
|
||||
.then(shuffle)
|
||||
.then((coverArts) => {
|
||||
if (coverArts.length == 1) {
|
||||
const coverArt = coverArts[0]!;
|
||||
res.status(200);
|
||||
res.setHeader("content-type", coverArt.contentType);
|
||||
return res.send(coverArt.data);
|
||||
} else if (coverArts.length > 1) {
|
||||
const gravity = [...GRAVITY_9];
|
||||
return sharp({
|
||||
create: {
|
||||
width: size * 3,
|
||||
height: size * 3,
|
||||
channels: 3,
|
||||
background: { r: 255, g: 255, b: 255 },
|
||||
},
|
||||
})
|
||||
.composite(
|
||||
takeWithRepeats(coverArts, 9).map((art) => ({
|
||||
input: art?.data,
|
||||
gravity: gravity.pop(),
|
||||
}))
|
||||
)
|
||||
.png()
|
||||
.toBuffer()
|
||||
.then((image) => sharp(image).resize(size).png().toBuffer())
|
||||
.then((image) => {
|
||||
res.status(200);
|
||||
res.setHeader("content-type", "image/png");
|
||||
return res.send(image);
|
||||
});
|
||||
} else {
|
||||
return res.status(404).send();
|
||||
}
|
||||
})
|
||||
.catch((e: Error) => {
|
||||
logger.error(`Failed fetching image ${urn}/size/${size}`, {
|
||||
logger.error(`Failed fetching image ${urns.join("&")}/size/${size}`, {
|
||||
cause: e,
|
||||
});
|
||||
return res.status(500).send();
|
||||
});
|
||||
});
|
||||
|
||||
// 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(
|
||||
app,
|
||||
SOAP_PATH,
|
||||
@@ -747,10 +649,7 @@ function server(
|
||||
apiTokens,
|
||||
clock,
|
||||
i8n,
|
||||
serverOpts.smapiAuthTokens,
|
||||
serverOpts.smapiTokenStore,
|
||||
serverOpts.logRequests,
|
||||
serverOpts.tokenCleanupIntervalMinutes
|
||||
serverOpts.smapiAuthTokens
|
||||
);
|
||||
|
||||
if (serverOpts.applyContextPath) {
|
||||
|
||||
590
src/smapi.ts
@@ -15,12 +15,11 @@ import {
|
||||
AlbumSummary,
|
||||
ArtistSummary,
|
||||
Genre,
|
||||
Year,
|
||||
MusicService,
|
||||
Playlist,
|
||||
RadioStation,
|
||||
Rating,
|
||||
slice2,
|
||||
Sortable,
|
||||
Track,
|
||||
} from "./music_service";
|
||||
import { APITokens } from "./api_tokens";
|
||||
@@ -28,7 +27,7 @@ import { Clock } from "./clock";
|
||||
import { URLBuilder } from "./url_builder";
|
||||
import { asLANGs, I8N } from "./i8n";
|
||||
import { ICON, iconForGenre } from "./icon";
|
||||
import _ from "underscore";
|
||||
import _, { uniq } from "underscore";
|
||||
import { BUrn, formatForURL } from "./burn";
|
||||
import {
|
||||
isExpiredTokenError,
|
||||
@@ -36,11 +35,7 @@ import {
|
||||
SmapiAuthTokens,
|
||||
SMAPI_FAULT_LOGIN_UNAUTHORIZED,
|
||||
ToSmapiFault,
|
||||
SmapiToken,
|
||||
} 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 CREATE_REGISTRATION_ROUTE = "/registration/add";
|
||||
@@ -66,7 +61,7 @@ export const SONOS_RECOMMENDED_IMAGE_SIZES = [
|
||||
|
||||
const WSDL_FILE = path.resolve(
|
||||
__dirname,
|
||||
"Sonoswsdl-1.19.6-20231024.wsdl"
|
||||
"Sonoswsdl-1.19.4-20190411.142401-3.wsdl"
|
||||
);
|
||||
|
||||
export type Credentials = {
|
||||
@@ -165,20 +160,17 @@ class SonosSoap {
|
||||
bonobUrl: URLBuilder;
|
||||
smapiAuthTokens: SmapiAuthTokens;
|
||||
clock: Clock;
|
||||
tokenStore: SmapiTokenStore;
|
||||
|
||||
constructor(
|
||||
bonobUrl: URLBuilder,
|
||||
linkCodes: LinkCodes,
|
||||
smapiAuthTokens: SmapiAuthTokens,
|
||||
clock: Clock,
|
||||
tokenStore: SmapiTokenStore
|
||||
clock: Clock
|
||||
) {
|
||||
this.bonobUrl = bonobUrl;
|
||||
this.linkCodes = linkCodes;
|
||||
this.smapiAuthTokens = smapiAuthTokens;
|
||||
this.clock = clock;
|
||||
this.tokenStore = tokenStore;
|
||||
}
|
||||
|
||||
getAppLink(): GetAppLinkResult {
|
||||
@@ -200,11 +192,6 @@ class SonosSoap {
|
||||
};
|
||||
}
|
||||
|
||||
reportAccountAction = (args: any, _headers: any) => {
|
||||
logger.info('Sonos reportAccountAction: ' + JSON.stringify(args));
|
||||
return {};
|
||||
}
|
||||
|
||||
getDeviceAuthToken({
|
||||
linkCode,
|
||||
}: {
|
||||
@@ -245,18 +232,6 @@ 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";
|
||||
@@ -269,27 +244,18 @@ export type Container = {
|
||||
};
|
||||
|
||||
const genre = (bonobUrl: URLBuilder, genre: Genre) => ({
|
||||
itemType: "albumList",
|
||||
itemType: "container",
|
||||
id: `genre:${genre.id}`,
|
||||
title: genre.name,
|
||||
albumArtURI: iconArtURI(bonobUrl, iconForGenre(genre.name)).href(),
|
||||
});
|
||||
|
||||
const 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) => ({
|
||||
itemType: "playlist",
|
||||
id: `playlist:${playlist.id}`,
|
||||
title: playlist.name,
|
||||
albumArtURI: coverArtURI(bonobUrl, playlist).href(),
|
||||
albumArtURI: playlistAlbumArtURL(bonobUrl, playlist).href(),
|
||||
canPlay: true,
|
||||
canEnumerate: true,
|
||||
attributes: {
|
||||
readOnly: false,
|
||||
userContent: false,
|
||||
@@ -297,9 +263,29 @@ const playlist = (bonobUrl: URLBuilder, playlist: Playlist) => ({
|
||||
},
|
||||
});
|
||||
|
||||
export const coverArtURI = (
|
||||
export const playlistAlbumArtURL = (
|
||||
bonobUrl: URLBuilder,
|
||||
{ coverArt }: { coverArt?: BUrn | undefined }
|
||||
playlist: Playlist
|
||||
) => {
|
||||
const burns: BUrn[] = uniq(
|
||||
playlist.entries.filter((it) => it.coverArt != undefined),
|
||||
(it) => it.album.id
|
||||
).map((it) => it.coverArt!);
|
||||
if (burns.length == 0) {
|
||||
return iconArtURI(bonobUrl, "error");
|
||||
} else {
|
||||
return bonobUrl.append({
|
||||
pathname: `/art/${burns
|
||||
.slice(0, 9)
|
||||
.map((it) => encodeURIComponent(formatForURL(it)))
|
||||
.join("&")}/size/180`,
|
||||
});
|
||||
}
|
||||
};
|
||||
|
||||
export const defaultAlbumArtURI = (
|
||||
bonobUrl: URLBuilder,
|
||||
{ coverArt }: { coverArt: BUrn | undefined }
|
||||
) =>
|
||||
pipe(
|
||||
coverArt,
|
||||
@@ -312,11 +298,26 @@ export const coverArtURI = (
|
||||
O.getOrElseW(() => iconArtURI(bonobUrl, "vinyl"))
|
||||
);
|
||||
|
||||
export const iconArtURI = (bonobUrl: URLBuilder, icon: ICON, text: string | undefined = undefined) =>
|
||||
export const iconArtURI = (bonobUrl: URLBuilder, icon: ICON) =>
|
||||
bonobUrl.append({
|
||||
pathname: `/icon/${text == undefined ? icon : `${icon}:${text}`}/size/legacy`,
|
||||
pathname: `/icon/${icon}/size/legacy`,
|
||||
});
|
||||
|
||||
export const defaultArtistArtURI = (
|
||||
bonobUrl: URLBuilder,
|
||||
artist: ArtistSummary
|
||||
) =>
|
||||
pipe(
|
||||
artist.image,
|
||||
O.fromNullable,
|
||||
O.map((it) =>
|
||||
bonobUrl.append({
|
||||
pathname: `/art/${encodeURIComponent(formatForURL(it))}/size/180`,
|
||||
})
|
||||
),
|
||||
O.getOrElseW(() => iconArtURI(bonobUrl, "vinyl"))
|
||||
);
|
||||
|
||||
export const sonosifyMimeType = (mimeType: string) =>
|
||||
mimeType == "audio/x-flac" ? "audio/flac" : mimeType;
|
||||
|
||||
@@ -326,7 +327,7 @@ export const album = (bonobUrl: URLBuilder, album: AlbumSummary) => ({
|
||||
artist: album.artistName,
|
||||
artistId: `artist:${album.artistId}`,
|
||||
title: album.name,
|
||||
albumArtURI: coverArtURI(bonobUrl, album).href(),
|
||||
albumArtURI: defaultAlbumArtURI(bonobUrl, album).href(),
|
||||
canPlay: true,
|
||||
// defaults
|
||||
// canScroll: false,
|
||||
@@ -334,17 +335,10 @@ export const album = (bonobUrl: URLBuilder, album: AlbumSummary) => ({
|
||||
// canAddToFavorites: true
|
||||
});
|
||||
|
||||
export const internetRadioStation = (station: RadioStation) => ({
|
||||
itemType: "stream",
|
||||
id: `internetRadioStation:${station.id}`,
|
||||
title: station.name,
|
||||
mimeType: "audio/mpeg",
|
||||
});
|
||||
|
||||
export const track = (bonobUrl: URLBuilder, track: Track) => ({
|
||||
itemType: "track",
|
||||
id: `track:${track.id}`,
|
||||
mimeType: sonosifyMimeType(track.encoding.mimeType),
|
||||
mimeType: sonosifyMimeType(track.mimeType),
|
||||
title: track.name,
|
||||
|
||||
trackMetadata: {
|
||||
@@ -352,7 +346,7 @@ export const track = (bonobUrl: URLBuilder, track: Track) => ({
|
||||
albumId: `album:${track.album.id}`,
|
||||
albumArtist: track.artist.name,
|
||||
albumArtistId: track.artist.id ? `artist:${track.artist.id}` : undefined,
|
||||
albumArtURI: coverArtURI(bonobUrl, track).href(),
|
||||
albumArtURI: defaultAlbumArtURI(bonobUrl, track).href(),
|
||||
artist: track.artist.name,
|
||||
artistId: track.artist.id ? `artist:${track.artist.id}` : undefined,
|
||||
duration: track.duration,
|
||||
@@ -370,9 +364,57 @@ export const artist = (bonobUrl: URLBuilder, artist: ArtistSummary) => ({
|
||||
id: `artist:${artist.id}`,
|
||||
artistId: artist.id,
|
||||
title: artist.name,
|
||||
albumArtURI: coverArtURI(bonobUrl, { coverArt: artist.image }).href(),
|
||||
albumArtURI: defaultArtistArtURI(bonobUrl, artist).href(),
|
||||
});
|
||||
|
||||
export const scrollIndicesFrom = (things: Sortable[]) => {
|
||||
const indicies: Record<string, number | undefined> = {
|
||||
"A":undefined,
|
||||
"B":undefined,
|
||||
"C":undefined,
|
||||
"D":undefined,
|
||||
"E":undefined,
|
||||
"F":undefined,
|
||||
"G":undefined,
|
||||
"H":undefined,
|
||||
"I":undefined,
|
||||
"J":undefined,
|
||||
"K":undefined,
|
||||
"L":undefined,
|
||||
"M":undefined,
|
||||
"N":undefined,
|
||||
"O":undefined,
|
||||
"P":undefined,
|
||||
"Q":undefined,
|
||||
"R":undefined,
|
||||
"S":undefined,
|
||||
"T":undefined,
|
||||
"U":undefined,
|
||||
"V":undefined,
|
||||
"W":undefined,
|
||||
"X":undefined,
|
||||
"Y":undefined,
|
||||
"Z":undefined,
|
||||
}
|
||||
const upperNames = things.map(thing => thing.sortName.toUpperCase());
|
||||
for(var i = 0; i < upperNames.length; i++) {
|
||||
const char = upperNames[i]![0]!;
|
||||
if(Object.keys(indicies).includes(char) && indicies[char] == undefined) {
|
||||
indicies[char] = i;
|
||||
}
|
||||
}
|
||||
var lastIndex = 0;
|
||||
const result: string[] = [];
|
||||
Object.entries(indicies).forEach(([letter, index]) => {
|
||||
result.push(letter);
|
||||
if(index) {
|
||||
lastIndex = index;
|
||||
}
|
||||
result.push(`${lastIndex}`);
|
||||
})
|
||||
return result.join(",")
|
||||
}
|
||||
|
||||
function splitId<T>(id: string) {
|
||||
const [type, typeId] = id.split(":");
|
||||
return (t: T) => ({
|
||||
@@ -405,33 +447,9 @@ function bindSmapiSoapServiceToExpress(
|
||||
apiKeys: APITokens,
|
||||
clock: Clock,
|
||||
i8n: I8N,
|
||||
smapiAuthTokens: SmapiAuthTokens,
|
||||
tokenStore: SmapiTokenStore,
|
||||
_logRequests: boolean,
|
||||
tokenCleanupIntervalMinutes: number = 60
|
||||
smapiAuthTokens: SmapiAuthTokens
|
||||
) {
|
||||
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 sonosSoap = new SonosSoap(bonobUrl, linkCodes, smapiAuthTokens, clock);
|
||||
|
||||
const urlWithToken = (accessToken: string) =>
|
||||
bonobUrl.append({
|
||||
@@ -444,39 +462,18 @@ function bindSmapiSoapServiceToExpress(
|
||||
const credentialsFrom = E.fromNullable(new MissingLoginTokenError());
|
||||
return pipe(
|
||||
credentialsFrom(credentials),
|
||||
E.chain((credentials) => {
|
||||
// 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(
|
||||
E.chain((credentials) =>
|
||||
pipe(
|
||||
smapiAuthTokens.verify({
|
||||
token: credentials.loginToken.token,
|
||||
key: effectiveKey,
|
||||
key: credentials.loginToken.key,
|
||||
}),
|
||||
E.map((serviceToken) => ({
|
||||
serviceToken,
|
||||
credentials: {
|
||||
...credentials,
|
||||
loginToken: {
|
||||
...credentials.loginToken,
|
||||
key: effectiveKey,
|
||||
},
|
||||
},
|
||||
credentials,
|
||||
}))
|
||||
);
|
||||
}),
|
||||
)
|
||||
),
|
||||
E.map(({ serviceToken, credentials }) => ({
|
||||
serviceToken,
|
||||
credentials,
|
||||
@@ -485,49 +482,7 @@ function bindSmapiSoapServiceToExpress(
|
||||
);
|
||||
};
|
||||
|
||||
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 login = async (credentials?: Credentials) => {
|
||||
const authOrFail = pipe(
|
||||
auth(credentials),
|
||||
E.getOrElseW((fault) => fault)
|
||||
@@ -540,16 +495,9 @@ function bindSmapiSoapServiceToExpress(
|
||||
throw SMAPI_FAULT_LOGIN_UNAUTHORIZED;
|
||||
});
|
||||
} 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(
|
||||
musicService.refreshToken(authOrFail.expiredToken),
|
||||
TE.map((it) => {
|
||||
logger.info("Token refresh successful, issuing new SMAPI token");
|
||||
return smapiAuthTokens.issue(it.serviceToken);
|
||||
}),
|
||||
TE.tap(swapToken(undefined)),
|
||||
TE.map((it) => smapiAuthTokens.issue(it.serviceToken)),
|
||||
TE.map((newToken) => ({
|
||||
Fault: {
|
||||
faultcode: "Client.TokenRefreshRequired",
|
||||
@@ -562,10 +510,9 @@ function bindSmapiSoapServiceToExpress(
|
||||
},
|
||||
},
|
||||
})),
|
||||
TE.getOrElse((err) => {
|
||||
logger.error("Token refresh failed", { error: err });
|
||||
return T.of(SMAPI_FAULT_LOGIN_UNAUTHORIZED);
|
||||
})
|
||||
TE.getOrElse(() =>
|
||||
T.of(SMAPI_FAULT_LOGIN_UNAUTHORIZED)
|
||||
)
|
||||
)();
|
||||
} else {
|
||||
throw authOrFail.toSmapiFault();
|
||||
@@ -579,18 +526,8 @@ function bindSmapiSoapServiceToExpress(
|
||||
Sonos: {
|
||||
SonosSoap: {
|
||||
getAppLink: () => sonosSoap.getAppLink(),
|
||||
reportAccountAction: (args: any) =>
|
||||
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;
|
||||
},
|
||||
getDeviceAuthToken: ({ linkCode }: { linkCode: string }) =>
|
||||
sonosSoap.getDeviceAuthToken({ linkCode }),
|
||||
getLastUpdate: () => ({
|
||||
getLastUpdateResult: {
|
||||
autoRefreshEnabled: true,
|
||||
@@ -599,11 +536,9 @@ function bindSmapiSoapServiceToExpress(
|
||||
pollInterval: 60,
|
||||
},
|
||||
}),
|
||||
refreshAuthToken: async (_, _2, soapyHeaders: SoapyHeaders,
|
||||
{ headers }: Pick<Request, "headers">) => {
|
||||
const creds = useHeaderIfPresent(soapyHeaders?.credentials, headers);
|
||||
refreshAuthToken: async (_, _2, soapyHeaders: SoapyHeaders) => {
|
||||
const serviceToken = pipe(
|
||||
auth(creds),
|
||||
auth(soapyHeaders?.credentials),
|
||||
E.fold(
|
||||
(fault) =>
|
||||
isExpiredTokenError(fault)
|
||||
@@ -615,12 +550,9 @@ function bindSmapiSoapServiceToExpress(
|
||||
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(
|
||||
musicService.refreshToken(serviceToken),
|
||||
TE.map((it) => smapiAuthTokens.issue(it.serviceToken)),
|
||||
TE.tap(swapToken(undefined)), // ignores the return value, like a tee or peek
|
||||
TE.map((it) => ({
|
||||
refreshAuthTokenResult: {
|
||||
authToken: it.token,
|
||||
@@ -635,19 +567,11 @@ function bindSmapiSoapServiceToExpress(
|
||||
getMediaURI: async (
|
||||
{ id }: { id: string },
|
||||
_,
|
||||
soapyHeaders: SoapyHeaders,
|
||||
{ headers }: Pick<Request, "headers">
|
||||
) => {
|
||||
return login(soapyHeaders?.credentials, headers)
|
||||
soapyHeaders: SoapyHeaders
|
||||
) =>
|
||||
login(soapyHeaders?.credentials)
|
||||
.then(splitId(id))
|
||||
.then(({ musicLibrary, credentials, type, typeId }) => {
|
||||
switch (type) {
|
||||
case "internetRadioStation":
|
||||
return musicLibrary.radioStation(typeId).then((it) => ({
|
||||
getMediaURIResult: it.url,
|
||||
}));
|
||||
case "track":
|
||||
return {
|
||||
.then(({ credentials, type, typeId }) => ({
|
||||
getMediaURIResult: bonobUrl
|
||||
.append({
|
||||
pathname: `/stream/${type}/${typeId}`,
|
||||
@@ -667,42 +591,25 @@ function bindSmapiSoapServiceToExpress(
|
||||
},
|
||||
},
|
||||
],
|
||||
};
|
||||
default:
|
||||
throw `Unsupported type:${type}`;
|
||||
}
|
||||
});
|
||||
},
|
||||
})),
|
||||
getMediaMetadata: async (
|
||||
{ id }: { id: string },
|
||||
_,
|
||||
soapyHeaders: SoapyHeaders,
|
||||
{ headers }: Pick<Request, "headers">
|
||||
) => {
|
||||
return login(soapyHeaders?.credentials, headers)
|
||||
soapyHeaders: SoapyHeaders
|
||||
) =>
|
||||
login(soapyHeaders?.credentials)
|
||||
.then(splitId(id))
|
||||
.then(async ({ musicLibrary, apiKey, type, typeId }) => {
|
||||
switch (type) {
|
||||
case "internetRadioStation":
|
||||
return musicLibrary.radioStation(typeId).then((it) => ({
|
||||
getMediaMetadataResult: internetRadioStation(it),
|
||||
}));
|
||||
case "track":
|
||||
return musicLibrary.track(typeId!).then((it) => ({
|
||||
.then(async ({ musicLibrary, apiKey, typeId }) =>
|
||||
musicLibrary.track(typeId!).then((it) => ({
|
||||
getMediaMetadataResult: track(urlWithToken(apiKey), it),
|
||||
}));
|
||||
default:
|
||||
throw `Unsupported type:${type}`;
|
||||
}
|
||||
});
|
||||
},
|
||||
}))
|
||||
),
|
||||
search: async (
|
||||
{ id, term }: { id: string; term: string },
|
||||
_,
|
||||
soapyHeaders: SoapyHeaders,
|
||||
{ headers }: Pick<Request, "headers">
|
||||
) => {
|
||||
return login(soapyHeaders?.credentials, headers)
|
||||
soapyHeaders: SoapyHeaders
|
||||
) =>
|
||||
login(soapyHeaders?.credentials)
|
||||
.then(splitId(id))
|
||||
.then(async ({ musicLibrary, apiKey }) => {
|
||||
switch (id) {
|
||||
@@ -728,16 +635,15 @@ function bindSmapiSoapServiceToExpress(
|
||||
return musicLibrary.searchTracks(term).then((it) =>
|
||||
searchResult({
|
||||
count: it.length,
|
||||
mediaMetadata: it.map((aTrack) =>
|
||||
track(urlWithToken(apiKey), aTrack)
|
||||
mediaCollection: it.map((aTrack) =>
|
||||
album(urlWithToken(apiKey), aTrack.album)
|
||||
),
|
||||
})
|
||||
);
|
||||
default:
|
||||
throw `Unsupported search by:${id}`;
|
||||
}
|
||||
});
|
||||
},
|
||||
}),
|
||||
getExtendedMetadata: async (
|
||||
{
|
||||
id,
|
||||
@@ -746,10 +652,9 @@ function bindSmapiSoapServiceToExpress(
|
||||
}: // recursive,
|
||||
{ id: string; index: number; count: number; recursive: boolean },
|
||||
_,
|
||||
soapyHeaders: SoapyHeaders,
|
||||
{ headers }: Pick<Request, "headers">
|
||||
) => {
|
||||
return login(soapyHeaders?.credentials, headers)
|
||||
soapyHeaders: SoapyHeaders
|
||||
) =>
|
||||
login(soapyHeaders?.credentials)
|
||||
.then(splitId(id))
|
||||
.then(async ({ musicLibrary, apiKey, type, typeId }) => {
|
||||
const paging = { _index: index, _count: count };
|
||||
@@ -806,35 +711,10 @@ function bindSmapiSoapServiceToExpress(
|
||||
// </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:
|
||||
throw `Unsupported getExtendedMetadata id=${id}`;
|
||||
}
|
||||
});
|
||||
},
|
||||
}),
|
||||
getMetadata: async (
|
||||
{
|
||||
id,
|
||||
@@ -845,12 +725,12 @@ function bindSmapiSoapServiceToExpress(
|
||||
_,
|
||||
soapyHeaders: SoapyHeaders,
|
||||
{ headers }: Pick<Request, "headers">
|
||||
) => {
|
||||
const acceptLanguage = headers["accept-language"];
|
||||
return login(soapyHeaders?.credentials, headers)
|
||||
) =>
|
||||
login(soapyHeaders?.credentials)
|
||||
.then(splitId(id))
|
||||
.then(({ musicLibrary, apiKey, type, typeId }) => {
|
||||
const paging = { _index: index, _count: count };
|
||||
const acceptLanguage = headers["accept-language"];
|
||||
logger.debug(
|
||||
`Fetching metadata type=${type}, typeId=${typeId}, acceptLanguage=${acceptLanguage}`
|
||||
);
|
||||
@@ -876,6 +756,7 @@ function bindSmapiSoapServiceToExpress(
|
||||
title: lang("artists"),
|
||||
albumArtURI: iconArtURI(bonobUrl, "artists").href(),
|
||||
itemType: "container",
|
||||
canScroll: true,
|
||||
},
|
||||
{
|
||||
id: "albums",
|
||||
@@ -905,8 +786,7 @@ function bindSmapiSoapServiceToExpress(
|
||||
id: "playlists",
|
||||
title: lang("playlists"),
|
||||
albumArtURI: iconArtURI(bonobUrl, "playlists").href(),
|
||||
itemType: "container",
|
||||
canEnumerate: true,
|
||||
itemType: "playlist",
|
||||
attributes: {
|
||||
readOnly: false,
|
||||
userContent: true,
|
||||
@@ -919,12 +799,6 @@ function bindSmapiSoapServiceToExpress(
|
||||
albumArtURI: iconArtURI(bonobUrl, "genres").href(),
|
||||
itemType: "container",
|
||||
},
|
||||
{
|
||||
id: "years",
|
||||
title: lang("years"),
|
||||
albumArtURI: iconArtURI(bonobUrl, "music").href(),
|
||||
itemType: "container",
|
||||
},
|
||||
{
|
||||
id: "recentlyAdded",
|
||||
title: lang("recentlyAdded"),
|
||||
@@ -952,12 +826,6 @@ function bindSmapiSoapServiceToExpress(
|
||||
).href(),
|
||||
itemType: "albumList",
|
||||
},
|
||||
{
|
||||
id: "internetRadio",
|
||||
title: lang("internetRadio"),
|
||||
albumArtURI: iconArtURI(bonobUrl, "radio").href(),
|
||||
itemType: "stream",
|
||||
},
|
||||
],
|
||||
});
|
||||
case "search":
|
||||
@@ -1002,13 +870,6 @@ function bindSmapiSoapServiceToExpress(
|
||||
genre: typeId,
|
||||
...paging,
|
||||
});
|
||||
case "year":
|
||||
return albums({
|
||||
type: "byYear",
|
||||
fromYear: typeId,
|
||||
toYear: typeId,
|
||||
...paging,
|
||||
});
|
||||
case "randomAlbums":
|
||||
return albums({
|
||||
type: "random",
|
||||
@@ -1039,32 +900,6 @@ function bindSmapiSoapServiceToExpress(
|
||||
type: "mostPlayed",
|
||||
...paging,
|
||||
});
|
||||
case "internetRadio":
|
||||
return musicLibrary
|
||||
.radioStations()
|
||||
.then(slice2(paging))
|
||||
.then(([page, total]) =>
|
||||
getMetadataResult({
|
||||
mediaMetadata: page.map((it) =>
|
||||
internetRadioStation(it)
|
||||
),
|
||||
index: paging._index,
|
||||
total,
|
||||
})
|
||||
);
|
||||
case "years":
|
||||
return musicLibrary
|
||||
.years()
|
||||
.then(slice2(paging))
|
||||
.then(([page, total]) =>
|
||||
getMetadataResult({
|
||||
mediaCollection: page.map((it) =>
|
||||
yyyy(bonobUrl, it)
|
||||
),
|
||||
index: paging._index,
|
||||
total,
|
||||
})
|
||||
);
|
||||
case "genres":
|
||||
return musicLibrary
|
||||
.genres()
|
||||
@@ -1083,16 +918,9 @@ function bindSmapiSoapServiceToExpress(
|
||||
.playlists()
|
||||
.then((it) =>
|
||||
Promise.all(
|
||||
it.map((playlist) => {
|
||||
// todo: whats this odd copy all about, can we just delete it?
|
||||
return {
|
||||
id: playlist.id,
|
||||
name: playlist.name,
|
||||
coverArt: playlist.coverArt,
|
||||
// todo: are these every important?
|
||||
entries: [],
|
||||
};
|
||||
})
|
||||
it.map((playlist) =>
|
||||
musicLibrary.playlist(playlist.id)
|
||||
)
|
||||
)
|
||||
)
|
||||
.then(slice2(paging))
|
||||
@@ -1124,15 +952,15 @@ function bindSmapiSoapServiceToExpress(
|
||||
.artist(typeId!)
|
||||
.then((artist) => artist.albums)
|
||||
.then(slice2(paging))
|
||||
.then(([page, total]) =>
|
||||
getMetadataResult({
|
||||
.then(([page, total]) => {
|
||||
return getMetadataResult({
|
||||
mediaCollection: page.map((it) =>
|
||||
album(urlWithToken(apiKey), it)
|
||||
),
|
||||
index: paging._index,
|
||||
total,
|
||||
})
|
||||
);
|
||||
});
|
||||
});
|
||||
case "relatedArtists":
|
||||
return musicLibrary
|
||||
.artist(typeId!)
|
||||
@@ -1166,15 +994,30 @@ function bindSmapiSoapServiceToExpress(
|
||||
default:
|
||||
throw `Unsupported getMetadata id=${id}`;
|
||||
}
|
||||
});
|
||||
}),
|
||||
getScrollIndices: async (
|
||||
{ id }: { id: string },
|
||||
_,
|
||||
soapyHeaders: SoapyHeaders
|
||||
) => {
|
||||
switch(id) {
|
||||
case "artists": {
|
||||
return login(soapyHeaders?.credentials)
|
||||
.then(({ musicLibrary }) => musicLibrary.artists({ _index: 0, _count: undefined }))
|
||||
.then((artists) => ({
|
||||
getScrollIndicesResult: scrollIndicesFrom(artists.results)
|
||||
}))
|
||||
}
|
||||
default:
|
||||
throw `Unsupported getScrollIndices id=${id}`;
|
||||
}
|
||||
},
|
||||
createContainer: async (
|
||||
{ title, seedId }: { title: string; seedId: string | undefined },
|
||||
_,
|
||||
soapyHeaders: SoapyHeaders,
|
||||
{ headers }: Pick<Request, "headers">
|
||||
) => {
|
||||
return login(soapyHeaders?.credentials, headers)
|
||||
soapyHeaders: SoapyHeaders
|
||||
) =>
|
||||
login(soapyHeaders?.credentials)
|
||||
.then(({ musicLibrary }) =>
|
||||
musicLibrary
|
||||
.createPlaylist(title)
|
||||
@@ -1194,38 +1037,32 @@ function bindSmapiSoapServiceToExpress(
|
||||
id: `playlist:${it.id}`,
|
||||
updateId: "",
|
||||
},
|
||||
}));
|
||||
},
|
||||
})),
|
||||
deleteContainer: async (
|
||||
{ id }: { id: string },
|
||||
_,
|
||||
soapyHeaders: SoapyHeaders,
|
||||
{ headers }: Pick<Request, "headers">
|
||||
) => {
|
||||
return login(soapyHeaders?.credentials, headers)
|
||||
soapyHeaders: SoapyHeaders
|
||||
) =>
|
||||
login(soapyHeaders?.credentials)
|
||||
.then(({ musicLibrary }) => musicLibrary.deletePlaylist(id))
|
||||
.then((_) => ({ deleteContainerResult: {} }));
|
||||
},
|
||||
.then((_) => ({ deleteContainerResult: {} })),
|
||||
addToContainer: async (
|
||||
{ id, parentId }: { id: string; parentId: string },
|
||||
_,
|
||||
soapyHeaders: SoapyHeaders,
|
||||
{ headers }: Pick<Request, "headers">
|
||||
) => {
|
||||
return login(soapyHeaders?.credentials, headers)
|
||||
soapyHeaders: SoapyHeaders
|
||||
) =>
|
||||
login(soapyHeaders?.credentials)
|
||||
.then(splitId(id))
|
||||
.then(({ musicLibrary, typeId }) =>
|
||||
musicLibrary.addToPlaylist(parentId.split(":")[1]!, typeId)
|
||||
)
|
||||
.then((_) => ({ addToContainerResult: { updateId: "" } }));
|
||||
},
|
||||
.then((_) => ({ addToContainerResult: { updateId: "" } })),
|
||||
removeFromContainer: async (
|
||||
{ id, indices }: { id: string; indices: string },
|
||||
_,
|
||||
soapyHeaders: SoapyHeaders,
|
||||
{ headers }: Pick<Request, "headers">
|
||||
) => {
|
||||
return login(soapyHeaders?.credentials, headers)
|
||||
soapyHeaders: SoapyHeaders
|
||||
) =>
|
||||
login(soapyHeaders?.credentials)
|
||||
.then(splitId(id))
|
||||
.then((it) => ({
|
||||
...it,
|
||||
@@ -1242,29 +1079,25 @@ function bindSmapiSoapServiceToExpress(
|
||||
musicLibrary.removeFromPlaylist(typeId, indices);
|
||||
}
|
||||
})
|
||||
.then((_) => ({ removeFromContainerResult: { updateId: "" } }));
|
||||
},
|
||||
.then((_) => ({ removeFromContainerResult: { updateId: "" } })),
|
||||
rateItem: async (
|
||||
{ id, rating }: { id: string; rating: number },
|
||||
_,
|
||||
soapyHeaders: SoapyHeaders,
|
||||
{ headers }: Pick<Request, "headers">
|
||||
) => {
|
||||
return login(soapyHeaders?.credentials, headers)
|
||||
soapyHeaders: SoapyHeaders
|
||||
) =>
|
||||
login(soapyHeaders?.credentials)
|
||||
.then(splitId(id))
|
||||
.then(({ musicLibrary, typeId }) =>
|
||||
musicLibrary.rate(typeId, ratingFromInt(Math.abs(rating)))
|
||||
)
|
||||
.then((_) => ({ rateItemResult: { shouldSkip: false } }));
|
||||
},
|
||||
.then((_) => ({ rateItemResult: { shouldSkip: false } })),
|
||||
|
||||
setPlayedSeconds: async (
|
||||
{ id, seconds }: { id: string; seconds: string },
|
||||
_,
|
||||
soapyHeaders: SoapyHeaders,
|
||||
{ headers }: Pick<Request, "headers">
|
||||
) => {
|
||||
return login(soapyHeaders?.credentials, headers)
|
||||
soapyHeaders: SoapyHeaders
|
||||
) =>
|
||||
login(soapyHeaders?.credentials)
|
||||
.then(splitId(id))
|
||||
.then(({ musicLibrary, type, typeId }) => {
|
||||
switch (type) {
|
||||
@@ -1286,49 +1119,7 @@ function bindSmapiSoapServiceToExpress(
|
||||
})
|
||||
.then((_) => ({
|
||||
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((_) => ({}));
|
||||
},
|
||||
})),
|
||||
},
|
||||
},
|
||||
},
|
||||
@@ -1342,9 +1133,8 @@ function bindSmapiSoapServiceToExpress(
|
||||
|
||||
soapyService.log = (type, data) => {
|
||||
switch (type) {
|
||||
// routing all soap info messages to debug so less noisy
|
||||
case "info":
|
||||
logger.debug({ level: "info", data });
|
||||
logger.info({ level: "info", data });
|
||||
break;
|
||||
case "warn":
|
||||
logger.warn({ level: "warn", data });
|
||||
|
||||
@@ -4,8 +4,6 @@ import { v4 as uuid } from "uuid";
|
||||
import { b64Decode, b64Encode } from "./b64";
|
||||
import { Clock } from "./clock";
|
||||
|
||||
import logger from "./logger";
|
||||
|
||||
export type SmapiFault = { Fault: { faultcode: string; faultstring: string } };
|
||||
export type SmapiRefreshTokenResultFault = SmapiFault & {
|
||||
Fault: {
|
||||
@@ -16,7 +14,6 @@ export type SmapiRefreshTokenResultFault = SmapiFault & {
|
||||
};
|
||||
|
||||
function isError(thing: any): thing is Error {
|
||||
logger.debug("isError check", { thing });
|
||||
return thing.name && thing.message;
|
||||
}
|
||||
|
||||
@@ -154,13 +151,6 @@ export class JWTSmapiLoginTokens implements SmapiAuthTokens {
|
||||
};
|
||||
|
||||
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 {
|
||||
return E.right(
|
||||
(
|
||||
@@ -171,9 +161,7 @@ export class JWTSmapiLoginTokens implements SmapiAuthTokens {
|
||||
).serviceToken
|
||||
);
|
||||
} catch (e) {
|
||||
const err = e as Error;
|
||||
if (isTokenExpiredError(e)) {
|
||||
logger.debug("JWT token expired, will attempt refresh", { expiredAt: (e as TokenExpiredError).expiredAt });
|
||||
const serviceToken = (
|
||||
jwt.verify(
|
||||
smapiToken.token,
|
||||
@@ -182,11 +170,8 @@ export class JWTSmapiLoginTokens implements SmapiAuthTokens {
|
||||
) as any
|
||||
).serviceToken;
|
||||
return E.left(new ExpiredTokenError(serviceToken));
|
||||
} else {
|
||||
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 if (isError(e)) return E.left(new InvalidTokenError(e.message));
|
||||
else return E.left(new InvalidTokenError("Failed to verify token"));
|
||||
}
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
@@ -1,166 +0,0 @@
|
||||
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;
|
||||
}
|
||||
}
|
||||
@@ -176,7 +176,7 @@ export function autoDiscoverySonos(sonosSeedHost?: string): Sonos {
|
||||
}
|
||||
})
|
||||
.catch((e) => {
|
||||
logger.error(`Failed looking for sonos devices - ${e}`, { cause: e });
|
||||
logger.error(`Failed looking for sonos devices`, { cause: e });
|
||||
return [];
|
||||
});
|
||||
};
|
||||
|
||||
@@ -1,200 +0,0 @@
|
||||
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 });
|
||||
}
|
||||
}
|
||||
}
|
||||
1149
src/subsonic.ts
770
src/subsonic/generic.ts
Normal file
@@ -0,0 +1,770 @@
|
||||
import { option as O, taskEither as TE } from "fp-ts";
|
||||
import * as A from "fp-ts/Array";
|
||||
import { pipe } from "fp-ts/lib/function";
|
||||
import { ordString } from "fp-ts/lib/Ord";
|
||||
import { inject } from "underscore";
|
||||
import _ from "underscore";
|
||||
|
||||
import logger from "../logger";
|
||||
import { b64Decode, b64Encode } from "../b64";
|
||||
import { assertSystem, BUrn, format } from "../burn";
|
||||
|
||||
import {
|
||||
Album,
|
||||
AlbumQuery,
|
||||
AlbumQueryType,
|
||||
AlbumSummary,
|
||||
Artist,
|
||||
ArtistQuery,
|
||||
ArtistSummary,
|
||||
AuthFailure,
|
||||
Credentials,
|
||||
Genre,
|
||||
IdName,
|
||||
Rating,
|
||||
Result,
|
||||
slice2,
|
||||
Sortable,
|
||||
Track,
|
||||
} from "../music_service";
|
||||
import {
|
||||
DODGY_IMAGE_NAME,
|
||||
StreamClientApplication,
|
||||
SubsonicCredentials,
|
||||
SubsonicMusicLibrary,
|
||||
SubsonicResponse,
|
||||
USER_AGENT,
|
||||
} from ".";
|
||||
import axios from "axios";
|
||||
import { asURLSearchParams } from "../utils";
|
||||
import { artistSummaryFromNDArtist, NDArtist } from "./navidrome";
|
||||
import { Http2, RequestParams } from "../http";
|
||||
import { client } from "./subsonic_http";
|
||||
|
||||
type album = {
|
||||
id: string;
|
||||
name: string;
|
||||
artist: string | undefined;
|
||||
artistId: string | undefined;
|
||||
coverArt: string | undefined;
|
||||
genre: string | undefined;
|
||||
year: string | undefined;
|
||||
};
|
||||
|
||||
type artist = {
|
||||
id: string;
|
||||
name: string;
|
||||
albumCount: number;
|
||||
artistImageUrl: string | undefined;
|
||||
};
|
||||
|
||||
type GetArtistsResponse = SubsonicResponse & {
|
||||
artists: {
|
||||
index: {
|
||||
artist: artist[];
|
||||
name: string;
|
||||
}[];
|
||||
};
|
||||
};
|
||||
|
||||
type GetAlbumListResponse = SubsonicResponse & {
|
||||
albumList2: {
|
||||
album: album[];
|
||||
};
|
||||
};
|
||||
|
||||
type genre = {
|
||||
songCount: number;
|
||||
albumCount: number;
|
||||
value: string;
|
||||
};
|
||||
|
||||
type GetGenresResponse = SubsonicResponse & {
|
||||
genres: {
|
||||
genre: genre[];
|
||||
};
|
||||
};
|
||||
|
||||
type GetArtistInfoResponse = SubsonicResponse & {
|
||||
artistInfo2: artistInfo;
|
||||
};
|
||||
|
||||
type GetArtistResponse = SubsonicResponse & {
|
||||
artist: artist & {
|
||||
album: album[];
|
||||
};
|
||||
};
|
||||
|
||||
export type images = {
|
||||
smallImageUrl: string | undefined;
|
||||
mediumImageUrl: string | undefined;
|
||||
largeImageUrl: string | undefined;
|
||||
};
|
||||
|
||||
type artistInfo = images & {
|
||||
biography: string | undefined;
|
||||
musicBrainzId: string | undefined;
|
||||
lastFmUrl: string | undefined;
|
||||
similarArtist: artist[];
|
||||
};
|
||||
|
||||
export type song = {
|
||||
id: string;
|
||||
parent: string | undefined;
|
||||
title: string;
|
||||
album: string | undefined;
|
||||
albumId: string | undefined;
|
||||
artist: string | undefined;
|
||||
artistId: string | undefined;
|
||||
track: number | undefined;
|
||||
year: string | undefined;
|
||||
genre: string | undefined;
|
||||
coverArt: string | undefined;
|
||||
created: string | undefined;
|
||||
duration: number | undefined;
|
||||
bitRate: number | undefined;
|
||||
suffix: string | undefined;
|
||||
contentType: string | undefined;
|
||||
type: string | undefined;
|
||||
userRating: number | undefined;
|
||||
starred: string | undefined;
|
||||
};
|
||||
|
||||
type GetAlbumResponse = {
|
||||
album: album & {
|
||||
song: song[];
|
||||
};
|
||||
};
|
||||
|
||||
type playlist = {
|
||||
id: string;
|
||||
name: string;
|
||||
};
|
||||
|
||||
type GetPlaylistResponse = {
|
||||
playlist: {
|
||||
id: string;
|
||||
name: string;
|
||||
entry: song[];
|
||||
};
|
||||
};
|
||||
|
||||
type GetPlaylistsResponse = {
|
||||
playlists: { playlist: playlist[] };
|
||||
};
|
||||
|
||||
type GetSimilarSongsResponse = {
|
||||
similarSongs2: { song: song[] };
|
||||
};
|
||||
|
||||
type GetTopSongsResponse = {
|
||||
topSongs: { song: song[] };
|
||||
};
|
||||
|
||||
type GetSongResponse = {
|
||||
song: song;
|
||||
};
|
||||
|
||||
type Search3Response = SubsonicResponse & {
|
||||
searchResult3: {
|
||||
artist: artist[];
|
||||
album: album[];
|
||||
song: song[];
|
||||
};
|
||||
};
|
||||
|
||||
const AlbumQueryTypeToSubsonicType: Record<AlbumQueryType, string> = {
|
||||
alphabeticalByArtist: "alphabeticalByArtist",
|
||||
alphabeticalByName: "alphabeticalByName",
|
||||
byGenre: "byGenre",
|
||||
random: "random",
|
||||
recentlyPlayed: "recent",
|
||||
mostPlayed: "frequent",
|
||||
recentlyAdded: "newest",
|
||||
favourited: "starred",
|
||||
starred: "highest",
|
||||
};
|
||||
|
||||
export const isValidImage = (url: string | undefined) =>
|
||||
url != undefined && !url.endsWith(DODGY_IMAGE_NAME);
|
||||
|
||||
const artistIsInLibrary = (artistId: string | undefined) =>
|
||||
artistId != undefined && artistId != "-1";
|
||||
|
||||
const coverArtURN = (coverArt: string | undefined): BUrn | undefined =>
|
||||
pipe(
|
||||
coverArt,
|
||||
O.fromNullable,
|
||||
O.map((it: string) => ({ system: "subsonic", resource: `art:${it}` })),
|
||||
O.getOrElseW(() => undefined)
|
||||
);
|
||||
|
||||
// todo: is this the right place for this??
|
||||
export const artistImageURN = (
|
||||
spec: Partial<{
|
||||
artistId: string | undefined;
|
||||
artistImageURL: string | undefined;
|
||||
}>
|
||||
): BUrn | undefined => {
|
||||
const deets = {
|
||||
artistId: undefined,
|
||||
artistImageURL: undefined,
|
||||
...spec,
|
||||
};
|
||||
if (deets.artistImageURL && isValidImage(deets.artistImageURL)) {
|
||||
return {
|
||||
system: "external",
|
||||
resource: deets.artistImageURL,
|
||||
};
|
||||
} else if (artistIsInLibrary(deets.artistId)) {
|
||||
return {
|
||||
system: "subsonic",
|
||||
resource: `art:${deets.artistId!}`,
|
||||
};
|
||||
} else {
|
||||
return undefined;
|
||||
}
|
||||
};
|
||||
|
||||
export const asTrack = (album: Album, song: song): Track => ({
|
||||
id: song.id,
|
||||
name: song.title,
|
||||
mimeType: song.contentType!,
|
||||
duration: song.duration || 0,
|
||||
number: song.track || 0,
|
||||
genre: maybeAsGenre(song.genre),
|
||||
coverArt: coverArtURN(song.coverArt),
|
||||
album,
|
||||
artist: {
|
||||
id: song.artistId,
|
||||
name: song.artist ? song.artist : "?",
|
||||
image: song.artistId
|
||||
? artistImageURN({ artistId: song.artistId })
|
||||
: undefined,
|
||||
},
|
||||
rating: {
|
||||
love: song.starred != undefined,
|
||||
stars:
|
||||
song.userRating && song.userRating <= 5 && song.userRating >= 0
|
||||
? song.userRating
|
||||
: 0,
|
||||
},
|
||||
});
|
||||
|
||||
const asAlbum = (album: album): Album => ({
|
||||
id: album.id,
|
||||
name: album.name,
|
||||
year: album.year,
|
||||
genre: maybeAsGenre(album.genre),
|
||||
artistId: album.artistId,
|
||||
artistName: album.artist,
|
||||
coverArt: coverArtURN(album.coverArt),
|
||||
});
|
||||
|
||||
export const asGenre = (genreName: string) => ({
|
||||
id: b64Encode(genreName),
|
||||
name: genreName,
|
||||
});
|
||||
|
||||
const maybeAsGenre = (genreName: string | undefined): Genre | undefined =>
|
||||
pipe(
|
||||
genreName,
|
||||
O.fromNullable,
|
||||
O.map(asGenre),
|
||||
O.getOrElseW(() => undefined)
|
||||
);
|
||||
|
||||
export class SubsonicGenericMusicLibrary implements SubsonicMusicLibrary {
|
||||
streamClientApplication: StreamClientApplication;
|
||||
subsonicHttp: Http2;
|
||||
|
||||
constructor(
|
||||
streamClientApplication: StreamClientApplication,
|
||||
subsonicHttp: Http2
|
||||
) {
|
||||
this.streamClientApplication = streamClientApplication;
|
||||
this.subsonicHttp = subsonicHttp;
|
||||
}
|
||||
|
||||
GET = (query: Partial<RequestParams>) => client(this.subsonicHttp)({ method: 'get', ...query });
|
||||
|
||||
flavour = () => "subsonic";
|
||||
|
||||
bearerToken = (_: Credentials): TE.TaskEither<Error, string | undefined> =>
|
||||
TE.right(undefined);
|
||||
|
||||
artists = async (q: ArtistQuery): Promise<Result<ArtistSummary & Sortable>> =>
|
||||
this.getArtists()
|
||||
.then(slice2(q))
|
||||
.then(([page, total]) => ({
|
||||
total,
|
||||
results: page.map((it) => ({
|
||||
id: it.id,
|
||||
name: it.name,
|
||||
sortName: it.name,
|
||||
image: it.image,
|
||||
})),
|
||||
}));
|
||||
|
||||
artist = async (id: string): Promise<Artist> => this.getArtistWithInfo(id);
|
||||
|
||||
albums = async (q: AlbumQuery): Promise<Result<AlbumSummary>> =>
|
||||
this.getAlbumList2(q);
|
||||
|
||||
album = (id: string): Promise<Album> => this.getAlbum(id);
|
||||
|
||||
genres = () =>
|
||||
this.GET({
|
||||
url: "/rest/getGenres",
|
||||
})
|
||||
.asJSON<GetGenresResponse>()
|
||||
.then((it) =>
|
||||
pipe(
|
||||
it.genres.genre || [],
|
||||
A.filter((it) => it.albumCount > 0),
|
||||
A.map((it) => it.value),
|
||||
A.sort(ordString),
|
||||
A.map((it) => ({ id: b64Encode(it), name: it }))
|
||||
)
|
||||
);
|
||||
|
||||
tracks = (albumId: string) =>
|
||||
this.GET({
|
||||
url: "/rest/getAlbum",
|
||||
params: {
|
||||
id: albumId,
|
||||
},
|
||||
})
|
||||
.asJSON<GetAlbumResponse>()
|
||||
.then((it) => it.album)
|
||||
.then((album) =>
|
||||
(album.song || []).map((song) => asTrack(asAlbum(album), song))
|
||||
);
|
||||
|
||||
track = (trackId: string) => this.getTrack(trackId);
|
||||
|
||||
rate = (trackId: string, rating: Rating) =>
|
||||
Promise.resolve(true)
|
||||
.then(() => {
|
||||
if (rating.stars >= 0 && rating.stars <= 5) {
|
||||
return this.getTrack(trackId);
|
||||
} else {
|
||||
throw `Invalid rating.stars value of ${rating.stars}`;
|
||||
}
|
||||
})
|
||||
.then((track) => {
|
||||
const thingsToUpdate = [];
|
||||
if (track.rating.love != rating.love) {
|
||||
thingsToUpdate.push(
|
||||
this.GET({
|
||||
url: `/rest/${rating.love ? "star" : "unstar"}`,
|
||||
params: {
|
||||
id: trackId,
|
||||
},
|
||||
}).asJSON()
|
||||
);
|
||||
}
|
||||
if (track.rating.stars != rating.stars) {
|
||||
thingsToUpdate.push(
|
||||
this.GET({
|
||||
url: `/rest/setRating`,
|
||||
params: {
|
||||
id: trackId,
|
||||
rating: rating.stars,
|
||||
},
|
||||
}).asJSON()
|
||||
);
|
||||
}
|
||||
return Promise.all(thingsToUpdate);
|
||||
})
|
||||
.then(() => true)
|
||||
.catch(() => false);
|
||||
|
||||
stream = async ({
|
||||
trackId,
|
||||
range,
|
||||
}: {
|
||||
trackId: string;
|
||||
range: string | undefined;
|
||||
}) =>
|
||||
this.getTrack(trackId).then((track) =>
|
||||
this.GET({
|
||||
url: "/rest/stream",
|
||||
params: {
|
||||
id: trackId,
|
||||
c: this.streamClientApplication(track),
|
||||
},
|
||||
headers: range != undefined ? { Range: range } : {},
|
||||
responseType: "stream",
|
||||
})
|
||||
.asRaw()
|
||||
.then((res) => ({
|
||||
status: res.status,
|
||||
headers: {
|
||||
"content-type": res.headers["content-type"],
|
||||
"content-length": res.headers["content-length"],
|
||||
"content-range": res.headers["content-range"],
|
||||
"accept-ranges": res.headers["accept-ranges"],
|
||||
},
|
||||
stream: res.data,
|
||||
}))
|
||||
);
|
||||
|
||||
coverArt = async (coverArtURN: BUrn, size?: number) =>
|
||||
Promise.resolve(coverArtURN)
|
||||
.then((it) => assertSystem(it, "subsonic"))
|
||||
.then((it) => it.resource.split(":")[1]!)
|
||||
.then((it) => this.getCoverArt(it, size))
|
||||
.then((res) => ({
|
||||
contentType: res.headers["content-type"],
|
||||
data: Buffer.from(res.data, "binary"),
|
||||
}))
|
||||
.catch((e) => {
|
||||
logger.error(
|
||||
`Failed getting coverArt for '${format(coverArtURN)}': ${e}`
|
||||
);
|
||||
return undefined;
|
||||
});
|
||||
|
||||
scrobble = async (id: string) =>
|
||||
this.GET({
|
||||
url: `/rest/scrobble`,
|
||||
params: {
|
||||
id,
|
||||
submission: true,
|
||||
},
|
||||
})
|
||||
.asJSON()
|
||||
.then((_) => true)
|
||||
.catch(() => false);
|
||||
|
||||
nowPlaying = async (id: string) =>
|
||||
this.GET({
|
||||
url: `/rest/scrobble`,
|
||||
params: {
|
||||
id,
|
||||
submission: false,
|
||||
},
|
||||
})
|
||||
.asJSON()
|
||||
.then((_) => true)
|
||||
.catch(() => false);
|
||||
|
||||
searchArtists = async (query: string) =>
|
||||
this.search3({ query, artistCount: 20 }).then(({ artists }) =>
|
||||
artists.map((artist) => ({
|
||||
id: artist.id,
|
||||
name: artist.name,
|
||||
image: artistImageURN({
|
||||
artistId: artist.id,
|
||||
artistImageURL: artist.artistImageUrl,
|
||||
}),
|
||||
}))
|
||||
);
|
||||
|
||||
searchAlbums = async (query: string) =>
|
||||
this.search3({ query, albumCount: 20 }).then(({ albums }) =>
|
||||
this.toAlbumSummary(albums)
|
||||
);
|
||||
|
||||
searchTracks = async (query: string) =>
|
||||
this.search3({ query, songCount: 20 }).then(({ songs }) =>
|
||||
Promise.all(songs.map((it) => this.getTrack(it.id)))
|
||||
);
|
||||
|
||||
playlists = async () =>
|
||||
this.GET({ url: "/rest/getPlaylists" })
|
||||
.asJSON<GetPlaylistsResponse>()
|
||||
.then((it) => it.playlists.playlist || [])
|
||||
.then((playlists) =>
|
||||
playlists.map((it) => ({ id: it.id, name: it.name }))
|
||||
);
|
||||
|
||||
playlist = async (id: string) =>
|
||||
this.GET({
|
||||
url: "/rest/getPlaylist",
|
||||
params: {
|
||||
id,
|
||||
},
|
||||
})
|
||||
.asJSON<GetPlaylistResponse>()
|
||||
.then((it) => it.playlist)
|
||||
.then((playlist) => {
|
||||
let trackNumber = 1;
|
||||
return {
|
||||
id: playlist.id,
|
||||
name: playlist.name,
|
||||
entries: (playlist.entry || []).map((entry) => ({
|
||||
...asTrack(
|
||||
{
|
||||
id: entry.albumId!,
|
||||
name: entry.album!,
|
||||
year: entry.year,
|
||||
genre: maybeAsGenre(entry.genre),
|
||||
artistName: entry.artist,
|
||||
artistId: entry.artistId,
|
||||
coverArt: coverArtURN(entry.coverArt),
|
||||
},
|
||||
entry
|
||||
),
|
||||
number: trackNumber++,
|
||||
})),
|
||||
};
|
||||
});
|
||||
|
||||
createPlaylist = async (name: string) =>
|
||||
this.GET({
|
||||
url: "/rest/createPlaylist",
|
||||
params: {
|
||||
name,
|
||||
},
|
||||
})
|
||||
.asJSON<GetPlaylistResponse>()
|
||||
.then((it) => it.playlist)
|
||||
.then((it) => ({ id: it.id, name: it.name }));
|
||||
|
||||
deletePlaylist = async (id: string) =>
|
||||
this.GET({
|
||||
url: "/rest/deletePlaylist",
|
||||
params: {
|
||||
id,
|
||||
},
|
||||
})
|
||||
.asJSON<GetPlaylistResponse>()
|
||||
.then((_) => true);
|
||||
|
||||
addToPlaylist = async (playlistId: string, trackId: string) =>
|
||||
this.GET({
|
||||
url: "/rest/updatePlaylist",
|
||||
params: {
|
||||
playlistId,
|
||||
songIdToAdd: trackId,
|
||||
},
|
||||
})
|
||||
.asJSON<GetPlaylistResponse>()
|
||||
.then((_) => true);
|
||||
|
||||
removeFromPlaylist = async (playlistId: string, indicies: number[]) =>
|
||||
this.GET({
|
||||
url: "/rest/updatePlaylist",
|
||||
params: {
|
||||
playlistId,
|
||||
songIndexToRemove: indicies,
|
||||
},
|
||||
})
|
||||
.asJSON<GetPlaylistResponse>()
|
||||
.then((_) => true);
|
||||
|
||||
similarSongs = async (id: string) =>
|
||||
this.GET({
|
||||
url: "/rest/getSimilarSongs2",
|
||||
params: { id, count: 50 },
|
||||
})
|
||||
.asJSON<GetSimilarSongsResponse>()
|
||||
.then((it) => it.similarSongs2.song || [])
|
||||
.then((songs) =>
|
||||
Promise.all(
|
||||
songs.map((song) =>
|
||||
this.getAlbum(song.albumId!).then((album) => asTrack(album, song))
|
||||
)
|
||||
)
|
||||
);
|
||||
|
||||
topSongs = async (artistId: string) =>
|
||||
this.getArtist(artistId).then(({ name }) =>
|
||||
this.GET({
|
||||
url: "/rest/getTopSongs",
|
||||
params: {
|
||||
artist: name,
|
||||
count: 50,
|
||||
},
|
||||
})
|
||||
.asJSON<GetTopSongsResponse>()
|
||||
.then((it) => it.topSongs.song || [])
|
||||
.then((songs) =>
|
||||
Promise.all(
|
||||
songs.map((song) =>
|
||||
this.getAlbum(song.albumId!).then((album) => asTrack(album, song))
|
||||
)
|
||||
)
|
||||
)
|
||||
);
|
||||
|
||||
private getArtists = (): Promise<
|
||||
(IdName & { albumCount: number; image: BUrn | undefined })[]
|
||||
> =>
|
||||
this.GET({ url: "/rest/getArtists" })
|
||||
.asJSON<GetArtistsResponse>()
|
||||
.then((it) => (it.artists.index || []).flatMap((it) => it.artist || []))
|
||||
.then((artists) =>
|
||||
artists.map((artist) => ({
|
||||
id: `${artist.id}`,
|
||||
name: artist.name,
|
||||
albumCount: artist.albumCount,
|
||||
image: artistImageURN({
|
||||
artistId: artist.id,
|
||||
artistImageURL: artist.artistImageUrl,
|
||||
}),
|
||||
}))
|
||||
);
|
||||
|
||||
private getArtistInfo = (
|
||||
id: string
|
||||
): Promise<{
|
||||
similarArtist: (ArtistSummary & { inLibrary: boolean })[];
|
||||
images: {
|
||||
s: string | undefined;
|
||||
m: string | undefined;
|
||||
l: string | undefined;
|
||||
};
|
||||
}> =>
|
||||
this.GET({
|
||||
url: "/rest/getArtistInfo2",
|
||||
params: {
|
||||
id,
|
||||
count: 50,
|
||||
includeNotPresent: true,
|
||||
},
|
||||
})
|
||||
.asJSON<GetArtistInfoResponse>()
|
||||
.then((it) => it.artistInfo2)
|
||||
.then((it) => ({
|
||||
images: {
|
||||
s: it.smallImageUrl,
|
||||
m: it.mediumImageUrl,
|
||||
l: it.largeImageUrl,
|
||||
},
|
||||
similarArtist: (it.similarArtist || []).map((artist) => ({
|
||||
id: `${artist.id}`,
|
||||
name: artist.name,
|
||||
inLibrary: artistIsInLibrary(artist.id),
|
||||
image: artistImageURN({
|
||||
artistId: artist.id,
|
||||
artistImageURL: artist.artistImageUrl,
|
||||
}),
|
||||
})),
|
||||
}));
|
||||
|
||||
private getAlbum = (id: string): Promise<Album> =>
|
||||
this.GET({ url: "/rest/getAlbum", params: { id } })
|
||||
.asJSON<GetAlbumResponse>()
|
||||
.then((it) => it.album)
|
||||
.then((album) => ({
|
||||
id: album.id,
|
||||
name: album.name,
|
||||
year: album.year,
|
||||
genre: maybeAsGenre(album.genre),
|
||||
artistId: album.artistId,
|
||||
artistName: album.artist,
|
||||
coverArt: coverArtURN(album.coverArt),
|
||||
}));
|
||||
|
||||
private getArtist = (
|
||||
id: string
|
||||
): Promise<
|
||||
IdName & { artistImageUrl: string | undefined; albums: AlbumSummary[] }
|
||||
> =>
|
||||
this.GET({
|
||||
url: "/rest/getArtist",
|
||||
params: {
|
||||
id,
|
||||
},
|
||||
})
|
||||
.asJSON<GetArtistResponse>()
|
||||
.then((it) => it.artist)
|
||||
.then((it) => ({
|
||||
id: it.id,
|
||||
name: it.name,
|
||||
artistImageUrl: it.artistImageUrl,
|
||||
albums: this.toAlbumSummary(it.album || []),
|
||||
}));
|
||||
|
||||
private getArtistWithInfo = (id: string) =>
|
||||
Promise.all([this.getArtist(id), this.getArtistInfo(id)]).then(
|
||||
([artist, artistInfo]) => ({
|
||||
id: artist.id,
|
||||
name: artist.name,
|
||||
image: artistImageURN({
|
||||
artistId: artist.id,
|
||||
artistImageURL: [
|
||||
artist.artistImageUrl,
|
||||
artistInfo.images.l,
|
||||
artistInfo.images.m,
|
||||
artistInfo.images.s,
|
||||
].find(isValidImage),
|
||||
}),
|
||||
albums: artist.albums,
|
||||
similarArtists: artistInfo.similarArtist,
|
||||
})
|
||||
);
|
||||
|
||||
private getCoverArt = (id: string, size?: number) =>
|
||||
this.GET({
|
||||
url: "/rest/getCoverArt",
|
||||
params: { id, size },
|
||||
responseType: "arraybuffer",
|
||||
}).asRaw();
|
||||
|
||||
private getTrack = (id: string) =>
|
||||
this.GET({
|
||||
url: "/rest/getSong",
|
||||
params: {
|
||||
id,
|
||||
},
|
||||
})
|
||||
.asJSON<GetSongResponse>()
|
||||
.then((it) => it.song)
|
||||
.then((song) =>
|
||||
this.getAlbum(song.albumId!).then((album) => asTrack(album, song))
|
||||
);
|
||||
|
||||
private toAlbumSummary = (albumList: album[]): AlbumSummary[] =>
|
||||
albumList.map((album) => ({
|
||||
id: album.id,
|
||||
name: album.name,
|
||||
year: album.year,
|
||||
genre: maybeAsGenre(album.genre),
|
||||
artistId: album.artistId,
|
||||
artistName: album.artist,
|
||||
coverArt: coverArtURN(album.coverArt),
|
||||
}));
|
||||
|
||||
private search3 = (q: any) =>
|
||||
this.GET({
|
||||
url: "/rest/search3",
|
||||
params: {
|
||||
artistCount: 0,
|
||||
albumCount: 0,
|
||||
songCount: 0,
|
||||
...q,
|
||||
},
|
||||
})
|
||||
.asJSON<Search3Response>()
|
||||
.then((it) => ({
|
||||
artists: it.searchResult3.artist || [],
|
||||
albums: it.searchResult3.album || [],
|
||||
songs: it.searchResult3.song || [],
|
||||
}));
|
||||
|
||||
private getAlbumList2 = (q: AlbumQuery) =>
|
||||
Promise.all([
|
||||
this.getArtists().then((it) =>
|
||||
inject(it, (total, artist) => total + artist.albumCount, 0)
|
||||
),
|
||||
this.GET({
|
||||
url: "/rest/getAlbumList2",
|
||||
params: {
|
||||
type: AlbumQueryTypeToSubsonicType[q.type],
|
||||
...(q.genre ? { genre: b64Decode(q.genre) } : {}),
|
||||
size: 500,
|
||||
offset: q._index,
|
||||
},
|
||||
})
|
||||
.asJSON<GetAlbumListResponse>()
|
||||
.then((response) => response.albumList2.album || [])
|
||||
.then(this.toAlbumSummary),
|
||||
]).then(([total, albums]) => ({
|
||||
results: albums.slice(0, q._count),
|
||||
total: albums.length == 500 ? total : (q._index || 0) + albums.length,
|
||||
}));
|
||||
}
|
||||
176
src/subsonic/index.ts
Normal file
@@ -0,0 +1,176 @@
|
||||
import { taskEither as TE } from "fp-ts";
|
||||
import { pipe } from "fp-ts/lib/function";
|
||||
import { Md5 } from "ts-md5/dist/md5";
|
||||
import axios from "axios";
|
||||
import randomstring from "randomstring";
|
||||
import _ from "underscore";
|
||||
// todo: rename http2 to http
|
||||
import { Http2, http2From } from "../http";
|
||||
|
||||
import {
|
||||
Credentials,
|
||||
MusicService,
|
||||
MusicLibrary,
|
||||
Track,
|
||||
AuthFailure,
|
||||
} from "../music_service";
|
||||
import { b64Encode, b64Decode } from "../b64";
|
||||
import { axiosImageFetcher, ImageFetcher } from "../images";
|
||||
import { navidromeMusicLibrary, SubsonicGenericMusicLibrary } from "./generic";
|
||||
import { client } from "./subsonic_http";
|
||||
|
||||
export const t = (password: string, s: string) =>
|
||||
Md5.hashStr(`${password}${s}`);
|
||||
|
||||
export const t_and_s = (password: string) => {
|
||||
const s = randomstring.generate();
|
||||
return {
|
||||
t: t(password, s),
|
||||
s,
|
||||
};
|
||||
};
|
||||
|
||||
// todo: this is an ND thing
|
||||
export const DODGY_IMAGE_NAME = "2a96cbd8b46e442fc41c2b86b821562f.png";
|
||||
|
||||
export type SubsonicEnvelope = {
|
||||
"subsonic-response": SubsonicResponse;
|
||||
};
|
||||
|
||||
export type SubsonicResponse = {
|
||||
status: string;
|
||||
};
|
||||
|
||||
export type SubsonicError = SubsonicResponse & {
|
||||
error: {
|
||||
code: string;
|
||||
message: string;
|
||||
};
|
||||
};
|
||||
|
||||
export type PingResponse = {
|
||||
status: string;
|
||||
version: string;
|
||||
type: string;
|
||||
serverVersion: string;
|
||||
};
|
||||
|
||||
export function isError(
|
||||
subsonicResponse: SubsonicResponse
|
||||
): subsonicResponse is SubsonicError {
|
||||
return (subsonicResponse as SubsonicError).error !== undefined;
|
||||
}
|
||||
|
||||
// todo: is this a good name?
|
||||
export type StreamClientApplication = (track: Track) => string;
|
||||
|
||||
export const DEFAULT_CLIENT_APPLICATION = "bonob";
|
||||
export const USER_AGENT = "bonob";
|
||||
|
||||
export const DEFAULT: StreamClientApplication = (_: Track) =>
|
||||
DEFAULT_CLIENT_APPLICATION;
|
||||
|
||||
export function appendMimeTypeToClientFor(mimeTypes: string[]) {
|
||||
return (track: Track) =>
|
||||
mimeTypes.includes(track.mimeType) ? `bonob+${track.mimeType}` : "bonob";
|
||||
}
|
||||
|
||||
export type SubsonicCredentials = Credentials & {
|
||||
type: string;
|
||||
bearer: string | undefined;
|
||||
};
|
||||
|
||||
export const asToken = (credentials: SubsonicCredentials) =>
|
||||
b64Encode(JSON.stringify(credentials));
|
||||
|
||||
export const parseToken = (token: string): SubsonicCredentials =>
|
||||
JSON.parse(b64Decode(token));
|
||||
|
||||
export interface SubsonicMusicLibrary extends MusicLibrary {
|
||||
flavour(): string;
|
||||
bearerToken(
|
||||
credentials: Credentials
|
||||
): TE.TaskEither<Error, string | undefined>;
|
||||
}
|
||||
|
||||
export class Subsonic implements MusicService {
|
||||
url: string;
|
||||
|
||||
// todo: does this need to be in here now?
|
||||
streamClientApplication: StreamClientApplication;
|
||||
// todo: why is this in here?
|
||||
externalImageFetcher: ImageFetcher;
|
||||
|
||||
subsonicHttp: Http2;
|
||||
|
||||
constructor(
|
||||
url: string,
|
||||
streamClientApplication: StreamClientApplication = DEFAULT,
|
||||
externalImageFetcher: ImageFetcher = axiosImageFetcher
|
||||
) {
|
||||
this.url = url;
|
||||
this.streamClientApplication = streamClientApplication;
|
||||
this.externalImageFetcher = externalImageFetcher;
|
||||
this.subsonicHttp = http2From(axios).with({
|
||||
baseURL: this.url,
|
||||
params: { v: "1.16.1", c: DEFAULT_CLIENT_APPLICATION },
|
||||
headers: { "User-Agent": "bonob" },
|
||||
});
|
||||
}
|
||||
|
||||
asAuthParams = (credentials: Credentials) => ({
|
||||
u: credentials.username,
|
||||
...t_and_s(credentials.password),
|
||||
})
|
||||
|
||||
generateToken = (credentials: Credentials) =>
|
||||
pipe(
|
||||
TE.tryCatch(
|
||||
() => client(this.subsonicHttp.with({ params: this.asAuthParams(credentials) } ))({ method: 'get', url: "/rest/ping.view" }).asJSON<PingResponse>(),
|
||||
(e) => new AuthFailure(e as string)
|
||||
),
|
||||
TE.chain(({ type }) =>
|
||||
pipe(
|
||||
TE.tryCatch(
|
||||
() => this.libraryFor({ ...credentials, type, bearer: undefined }),
|
||||
() => new AuthFailure("Failed to get library")
|
||||
),
|
||||
TE.map((library) => ({ type, library }))
|
||||
)
|
||||
),
|
||||
TE.chain(({ library, type }) =>
|
||||
pipe(
|
||||
library.bearerToken(credentials),
|
||||
TE.map((bearer) => ({ bearer, type }))
|
||||
)
|
||||
),
|
||||
TE.map(({ bearer, type }) => ({
|
||||
serviceToken: asToken({ ...credentials, bearer, type }),
|
||||
userId: credentials.username,
|
||||
nickname: credentials.username,
|
||||
}))
|
||||
);
|
||||
|
||||
refreshToken = (serviceToken: string) =>
|
||||
this.generateToken(parseToken(serviceToken));
|
||||
|
||||
login = async (token: string) => this.libraryFor(parseToken(token));
|
||||
|
||||
private libraryFor = (
|
||||
credentials: SubsonicCredentials
|
||||
): Promise<SubsonicMusicLibrary> => {
|
||||
const subsonicGenericLibrary = new SubsonicGenericMusicLibrary(
|
||||
this.streamClientApplication,
|
||||
this.subsonicHttp.with({ params: this.asAuthParams(credentials) } )
|
||||
);
|
||||
if (credentials.type == "navidrome") {
|
||||
return Promise.resolve(
|
||||
navidromeMusicLibrary(this.url, subsonicGenericLibrary, credentials)
|
||||
);
|
||||
} else {
|
||||
return Promise.resolve(subsonicGenericLibrary);
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
export default Subsonic;
|
||||
95
src/subsonic/navidrome.ts
Normal file
@@ -0,0 +1,95 @@
|
||||
import { option as O, taskEither as TE } from "fp-ts";
|
||||
import * as A from "fp-ts/Array";
|
||||
import { pipe } from "fp-ts/lib/function";
|
||||
import { ordString } from "fp-ts/lib/Ord";
|
||||
import { inject } from "underscore";
|
||||
import _ from "underscore";
|
||||
import axios from "axios";
|
||||
|
||||
import { SubsonicCredentials, SubsonicMusicLibrary } from ".";
|
||||
import { ArtistQuery, ArtistSummary, AuthFailure, Credentials, Result, Sortable } from "../music_service";
|
||||
import { artistImageURN } from "./generic";
|
||||
|
||||
export type NDArtist = {
|
||||
id: string;
|
||||
name: string;
|
||||
orderArtistName: string | undefined;
|
||||
largeImageUrl: string | undefined;
|
||||
};
|
||||
|
||||
export const artistSummaryFromNDArtist = (
|
||||
artist: NDArtist
|
||||
): ArtistSummary & Sortable => ({
|
||||
id: artist.id,
|
||||
name: artist.name,
|
||||
sortName: artist.orderArtistName || artist.name,
|
||||
image: artistImageURN({
|
||||
artistId: artist.id,
|
||||
artistImageURL: artist.largeImageUrl,
|
||||
}),
|
||||
});
|
||||
|
||||
|
||||
export const navidromeMusicLibrary = (
|
||||
url: string,
|
||||
subsonicLibrary: SubsonicMusicLibrary,
|
||||
subsonicCredentials: SubsonicCredentials
|
||||
): SubsonicMusicLibrary => ({
|
||||
...subsonicLibrary,
|
||||
flavour: () => "navidrome",
|
||||
bearerToken: (
|
||||
credentials: Credentials
|
||||
): TE.TaskEither<Error, string | undefined> =>
|
||||
pipe(
|
||||
TE.tryCatch(
|
||||
() =>
|
||||
// todo: not hardcode axios in here
|
||||
axios({
|
||||
method: "post",
|
||||
baseURL: url,
|
||||
url: `/auth/login`,
|
||||
data: _.pick(credentials, "username", "password"),
|
||||
}),
|
||||
() => new AuthFailure("Failed to get bearerToken")
|
||||
),
|
||||
TE.map((it) => it.data.token as string | undefined)
|
||||
),
|
||||
artists: async (
|
||||
q: ArtistQuery
|
||||
): Promise<Result<ArtistSummary & Sortable>> => {
|
||||
let params: any = {
|
||||
_sort: "name",
|
||||
_order: "ASC",
|
||||
_start: q._index || "0",
|
||||
};
|
||||
if (q._count) {
|
||||
params = {
|
||||
...params,
|
||||
_end: (q._index || 0) + q._count,
|
||||
};
|
||||
}
|
||||
|
||||
const x: Promise<Result<ArtistSummary & Sortable>> = axios
|
||||
.get(`${url}/api/artist`, {
|
||||
params: asURLSearchParams(params),
|
||||
headers: {
|
||||
"User-Agent": USER_AGENT,
|
||||
"x-nd-authorization": `Bearer ${subsonicCredentials.bearer}`,
|
||||
},
|
||||
})
|
||||
.catch((e) => {
|
||||
throw `Navidrome failed with: ${e}`;
|
||||
})
|
||||
.then((response) => {
|
||||
if (response.status != 200 && response.status != 206) {
|
||||
throw `Navidrome failed with a ${response.status || "no!"} status`;
|
||||
} else return response;
|
||||
})
|
||||
.then((it) => ({
|
||||
results: (it.data as NDArtist[]).map(artistSummaryFromNDArtist),
|
||||
total: Number.parseInt(it.headers["x-total-count"] || "0"),
|
||||
}));
|
||||
|
||||
return x;
|
||||
},
|
||||
});
|
||||
51
src/subsonic/subsonic_http.ts
Normal file
@@ -0,0 +1,51 @@
|
||||
import { AxiosResponse } from "axios";
|
||||
import { isError, SubsonicEnvelope } from ".";
|
||||
// todo: rename http2 to http
|
||||
import { Http2, RequestParams } from "../http";
|
||||
|
||||
export type HttpResponse = {
|
||||
data: any;
|
||||
status: number;
|
||||
headers: any;
|
||||
};
|
||||
|
||||
const asJSON = <T>(response: HttpResponse): T => {
|
||||
const subsonicResponse = (response.data as SubsonicEnvelope)[
|
||||
"subsonic-response"
|
||||
];
|
||||
if (isError(subsonicResponse))
|
||||
throw `Subsonic error:${subsonicResponse.error.message}`;
|
||||
else return subsonicResponse as unknown as T;
|
||||
};
|
||||
const throwUp = (error: any) => {
|
||||
throw `Subsonic failed with: ${error}`;
|
||||
};
|
||||
const verifyResponse = (response: AxiosResponse<any>) => {
|
||||
if (response.status != 200 && response.status != 206) {
|
||||
throw `Subsonic failed with a ${response.status || "no!"} status`;
|
||||
} else return response;
|
||||
};
|
||||
|
||||
export interface SubsonicHttpResponse {
|
||||
asRaw(): Promise<AxiosResponse<any>>;
|
||||
asJSON<T>(): Promise<T>;
|
||||
}
|
||||
|
||||
export interface SubsonicHttp {
|
||||
(query: Partial<RequestParams>): SubsonicHttpResponse;
|
||||
}
|
||||
|
||||
export const client = (http: Http2): SubsonicHttp => {
|
||||
return (query: Partial<RequestParams>): SubsonicHttpResponse => {
|
||||
return {
|
||||
asRaw: () => http(query).catch(throwUp).then(verifyResponse),
|
||||
|
||||
asJSON: <T>() =>
|
||||
http
|
||||
.with({ params: { f: "json" } })(query)
|
||||
.catch(throwUp)
|
||||
.then(verifyResponse)
|
||||
.then(asJSON) as Promise<T>,
|
||||
};
|
||||
};
|
||||
};
|
||||
58
src/utils.ts
@@ -1,34 +1,42 @@
|
||||
import { DOMParser, XMLSerializer, Node } from '@xmldom/xmldom';
|
||||
import { flatten } from "underscore";
|
||||
|
||||
// todo: move this
|
||||
export const BROWSER_HEADERS = {
|
||||
accept:
|
||||
"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8",
|
||||
"accept-encoding": "gzip, deflate, br",
|
||||
"accept-language": "en-GB,en;q=0.5",
|
||||
"upgrade-insecure-requests": "1",
|
||||
"user-agent":
|
||||
"Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:86.0) Gecko/20100101 Firefox/86.0",
|
||||
};
|
||||
|
||||
// todo: move this
|
||||
export const asURLSearchParams = (q: any) => {
|
||||
const urlSearchParams = new URLSearchParams();
|
||||
Object.keys(q).forEach((k) => {
|
||||
flatten([q[k]]).forEach((v) => {
|
||||
urlSearchParams.append(k, `${v}`);
|
||||
});
|
||||
});
|
||||
return urlSearchParams;
|
||||
};
|
||||
|
||||
export function takeWithRepeats<T>(things: T[], count: number) {
|
||||
const result = [];
|
||||
for (let i = 0; i < count; i++) {
|
||||
result.push(things[i % things.length])
|
||||
result.push(things[i % things.length]);
|
||||
}
|
||||
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);
|
||||
export const mask = (thing: any, fields: string[]) =>
|
||||
fields.reduce(
|
||||
(res: any, key: string) => {
|
||||
if (Object.keys(res).includes(key)) {
|
||||
res[key] = "****";
|
||||
}
|
||||
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);
|
||||
}
|
||||
|
||||
return res;
|
||||
},
|
||||
{ ...thing }
|
||||
);
|
||||
|
||||
@@ -14,11 +14,10 @@ import {
|
||||
Playlist,
|
||||
SimilarArtist,
|
||||
AlbumSummary,
|
||||
RadioStation
|
||||
} from "../src/music_service";
|
||||
|
||||
import { b64Encode } from "../src/b64";
|
||||
import { artistImageURN } from "../src/subsonic";
|
||||
import { artistImageURN } from "../src/subsonic/generic";
|
||||
|
||||
const randomInt = (max: number) => Math.floor(Math.random() * Math.floor(max));
|
||||
const randomIpAddress = () => `127.0.${randomInt(255)}.${randomInt(255)}`;
|
||||
@@ -174,10 +173,7 @@ export function aTrack(fields: Partial<Track> = {}): Track {
|
||||
return {
|
||||
id,
|
||||
name: `Track ${id}`,
|
||||
encoding: {
|
||||
player: "bonob",
|
||||
mimeType: `audio/mp3-${id}`
|
||||
},
|
||||
mimeType: `audio/mp3-${id}`,
|
||||
duration: randomInt(500),
|
||||
number: randomInt(100),
|
||||
genre,
|
||||
@@ -205,17 +201,6 @@ export function anAlbum(fields: Partial<Album> = {}): Album {
|
||||
};
|
||||
};
|
||||
|
||||
export function aRadioStation(fields: Partial<RadioStation> = {}): RadioStation {
|
||||
const id = uuid()
|
||||
const name = `Station-${id}`;
|
||||
return {
|
||||
id,
|
||||
name,
|
||||
url: `http://example.com/${name}`,
|
||||
...fields
|
||||
}
|
||||
}
|
||||
|
||||
export function anAlbumSummary(fields: Partial<AlbumSummary> = {}): AlbumSummary {
|
||||
const id = uuid();
|
||||
return {
|
||||
|
||||
@@ -271,15 +271,6 @@ describe("config", () => {
|
||||
});
|
||||
});
|
||||
|
||||
describe("logRequests", () => {
|
||||
describeBooleanConfigValue(
|
||||
"logRequests",
|
||||
"BNB_SERVER_LOG_REQUESTS",
|
||||
false,
|
||||
(config) => config.logRequests
|
||||
);
|
||||
});
|
||||
|
||||
describe("sonos", () => {
|
||||
describe("serviceName", () => {
|
||||
it("should default to bonob", () => {
|
||||
@@ -374,31 +365,23 @@ describe("config", () => {
|
||||
"BONOB_NAVIDROME_URL",
|
||||
])("%s", (k) => {
|
||||
describe(`when ${k} is not specified`, () => {
|
||||
it(`should default to http://${hostname()}:4533/`, () => {
|
||||
expect(config().subsonic.url.href()).toEqual(`http://${hostname()}:4533/`);
|
||||
it(`should default to http://${hostname()}:4533`, () => {
|
||||
expect(config().subsonic.url).toEqual(`http://${hostname()}:4533`);
|
||||
});
|
||||
});
|
||||
|
||||
describe(`when ${k} is ''`, () => {
|
||||
it(`should default to http://${hostname()}:4533/`, () => {
|
||||
it(`should default to http://${hostname()}:4533`, () => {
|
||||
process.env[k] = "";
|
||||
expect(config().subsonic.url.href()).toEqual(`http://${hostname()}:4533/`);
|
||||
expect(config().subsonic.url).toEqual(`http://${hostname()}:4533`);
|
||||
});
|
||||
});
|
||||
|
||||
describe(`when ${k} is specified`, () => {
|
||||
it(`should use it for ${k}`, () => {
|
||||
const url = "http://navidrome.example.com:1234/some-context-path";
|
||||
const url = "http://navidrome.example.com:1234";
|
||||
process.env[k] = 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);
|
||||
expect(config().subsonic.url).toEqual(url);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
@@ -1,5 +1,3 @@
|
||||
import { left, right } from 'fp-ts/Either'
|
||||
|
||||
import { cryptoEncryption, jwsEncryption } from '../src/encryption';
|
||||
|
||||
describe("jwsEncryption", () => {
|
||||
@@ -9,7 +7,7 @@ describe("jwsEncryption", () => {
|
||||
const value = "bobs your uncle"
|
||||
const hash = e.encrypt(value)
|
||||
expect(hash).not.toContain(value);
|
||||
expect(e.decrypt(hash)).toEqual(right(value));
|
||||
expect(e.decrypt(hash)).toEqual(value);
|
||||
});
|
||||
|
||||
it("returns different values for different secrets", () => {
|
||||
@@ -31,7 +29,7 @@ describe("cryptoEncryption", () => {
|
||||
const value = "bobs your uncle"
|
||||
const hash = e.encrypt(value)
|
||||
expect(hash).not.toContain(value);
|
||||
expect(e.decrypt(hash)).toEqual(right(value));
|
||||
expect(e.decrypt(hash)).toEqual(value);
|
||||
});
|
||||
|
||||
it("returns different values for different secrets", () => {
|
||||
@@ -44,10 +42,4 @@ describe("cryptoEncryption", () => {
|
||||
|
||||
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"));
|
||||
});
|
||||
})
|
||||
|
||||
277
tests/http.test.ts
Normal file
@@ -0,0 +1,277 @@
|
||||
import { http, http2From, } from "../src/http";
|
||||
|
||||
describe("http", () => {
|
||||
const mockAxios = jest.fn();
|
||||
|
||||
beforeEach(() => {
|
||||
jest.clearAllMocks();
|
||||
jest.resetAllMocks();
|
||||
});
|
||||
|
||||
describe.each([
|
||||
["baseURL"],
|
||||
["url"],
|
||||
["method"],
|
||||
])('%s', (field) => {
|
||||
const getValue = (value: string) => {
|
||||
const thing = {} as any;
|
||||
thing[field] = value;
|
||||
return thing;
|
||||
};
|
||||
|
||||
const base = http(mockAxios, getValue('base'));
|
||||
|
||||
describe("using default", () => {
|
||||
it("should use the default", () => {
|
||||
base({})
|
||||
expect(mockAxios).toHaveBeenCalledWith(getValue('base'));
|
||||
});
|
||||
});
|
||||
|
||||
describe("overriding", () => {
|
||||
it("should use the override", () => {
|
||||
base(getValue('override'))
|
||||
expect(mockAxios).toHaveBeenCalledWith(getValue('override'));
|
||||
});
|
||||
});
|
||||
|
||||
describe("wrapping", () => {
|
||||
const firstLayer = http(base, getValue('level1'));
|
||||
const secondLayer = http(firstLayer, getValue('level2'));
|
||||
|
||||
describe("when the outter call provides a value", () => {
|
||||
it("should apply it", () => {
|
||||
secondLayer(getValue('outter'))
|
||||
expect(mockAxios).toHaveBeenCalledWith(getValue('outter'));
|
||||
});
|
||||
});
|
||||
|
||||
describe("when the outter call does not provide a value", () => {
|
||||
it("should use the second layer", () => {
|
||||
secondLayer({ })
|
||||
expect(mockAxios).toHaveBeenCalledWith(getValue('level2'));
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe("requestType", () => {
|
||||
const base = http(mockAxios, { responseType: 'stream' });
|
||||
|
||||
describe("using default", () => {
|
||||
it("should use the default", () => {
|
||||
base({})
|
||||
expect(mockAxios).toHaveBeenCalledWith({ responseType: 'stream' });
|
||||
});
|
||||
});
|
||||
|
||||
describe("overriding", () => {
|
||||
it("should use the override", () => {
|
||||
base({ responseType: 'arraybuffer' })
|
||||
expect(mockAxios).toHaveBeenCalledWith({ responseType: 'arraybuffer' });
|
||||
});
|
||||
});
|
||||
|
||||
describe("wrapping", () => {
|
||||
const firstLayer = http(base, { responseType: 'arraybuffer' });
|
||||
const secondLayer = http(firstLayer, { responseType: 'blob' });
|
||||
|
||||
describe("when the outter call provides a value", () => {
|
||||
it("should apply it", () => {
|
||||
secondLayer({ responseType: 'text' })
|
||||
expect(mockAxios).toHaveBeenCalledWith({ responseType: 'text' });
|
||||
});
|
||||
});
|
||||
|
||||
describe("when the outter call does not provide a value", () => {
|
||||
it("should use the second layer", () => {
|
||||
secondLayer({ })
|
||||
expect(mockAxios).toHaveBeenCalledWith({ responseType: 'blob' });
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe.each([
|
||||
["params"],
|
||||
["headers"],
|
||||
])('%s', (field) => {
|
||||
const getValues = (values: any) => {
|
||||
const thing = {} as any;
|
||||
thing[field] = values;
|
||||
return thing;
|
||||
}
|
||||
const base = http(mockAxios, getValues({ a: 1, b: 2, c: 3, d: 4 }));
|
||||
|
||||
describe("using default", () => {
|
||||
it("should use the default", () => {
|
||||
base({});
|
||||
expect(mockAxios).toHaveBeenCalledWith(getValues({ a: 1, b: 2, c: 3, d: 4 }));
|
||||
});
|
||||
});
|
||||
|
||||
describe("overriding", () => {
|
||||
it("should use the override", () => {
|
||||
base(getValues({ b: 22, e: 5 }));
|
||||
expect(mockAxios).toHaveBeenCalledWith(getValues({ a: 1, b: 22, c: 3, d: 4, e: 5 }));
|
||||
});
|
||||
});
|
||||
|
||||
describe("wrapping", () => {
|
||||
const firstLayer = http(base, getValues({ b: 22 }));
|
||||
const secondLayer = http(firstLayer, getValues({ c: 33 }));
|
||||
|
||||
describe("when the outter call provides a value", () => {
|
||||
it("should apply it", () => {
|
||||
secondLayer(getValues({ a: 11, e: 5 }));
|
||||
expect(mockAxios).toHaveBeenCalledWith(getValues({ a: 11, b: 22, c: 33, d: 4, e: 5 }));
|
||||
});
|
||||
});
|
||||
|
||||
describe("when the outter call does not provide a value", () => {
|
||||
it("should use the second layer", () => {
|
||||
secondLayer({ });
|
||||
expect(mockAxios).toHaveBeenCalledWith(getValues({ a: 1, b: 22, c: 33, d: 4 }));
|
||||
});
|
||||
});
|
||||
});
|
||||
})
|
||||
});
|
||||
|
||||
describe("http2", () => {
|
||||
const mockAxios = jest.fn();
|
||||
|
||||
beforeEach(() => {
|
||||
jest.clearAllMocks();
|
||||
jest.resetAllMocks();
|
||||
});
|
||||
|
||||
describe.each([
|
||||
["baseURL"],
|
||||
["url"],
|
||||
["method"],
|
||||
])('%s', (field) => {
|
||||
const fieldWithValue = (value: string) => {
|
||||
const thing = {} as any;
|
||||
thing[field] = value;
|
||||
return thing;
|
||||
};
|
||||
|
||||
const base = http2From(mockAxios).with(fieldWithValue('default'));
|
||||
|
||||
describe("using default", () => {
|
||||
it("should use the default", () => {
|
||||
base({})
|
||||
expect(mockAxios).toHaveBeenCalledWith(fieldWithValue('default'));
|
||||
});
|
||||
});
|
||||
|
||||
describe("overriding", () => {
|
||||
it("should use the override", () => {
|
||||
base(fieldWithValue('override'))
|
||||
expect(mockAxios).toHaveBeenCalledWith(fieldWithValue('override'));
|
||||
});
|
||||
});
|
||||
|
||||
describe("wrapping", () => {
|
||||
const firstLayer = http2From(base).with(fieldWithValue('level1'));
|
||||
const secondLayer = firstLayer.with(fieldWithValue('level2'));
|
||||
|
||||
describe("when the outter call provides a value", () => {
|
||||
it("should apply it", () => {
|
||||
secondLayer(fieldWithValue('outter'))
|
||||
expect(mockAxios).toHaveBeenCalledWith(fieldWithValue('outter'));
|
||||
});
|
||||
});
|
||||
|
||||
describe("when the outter call does not provide a value", () => {
|
||||
it("should use the second layer", () => {
|
||||
secondLayer({ })
|
||||
expect(mockAxios).toHaveBeenCalledWith(fieldWithValue('level2'));
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe("requestType", () => {
|
||||
const base = http2From(mockAxios).with({ responseType: 'stream' });
|
||||
|
||||
describe("using default", () => {
|
||||
it("should use the default", () => {
|
||||
base({})
|
||||
expect(mockAxios).toHaveBeenCalledWith({ responseType: 'stream' });
|
||||
});
|
||||
});
|
||||
|
||||
describe("overriding", () => {
|
||||
it("should use the override", () => {
|
||||
base({ responseType: 'arraybuffer' })
|
||||
expect(mockAxios).toHaveBeenCalledWith({ responseType: 'arraybuffer' });
|
||||
});
|
||||
});
|
||||
|
||||
describe("wrapping", () => {
|
||||
const firstLayer = base.with({ responseType: 'arraybuffer' });
|
||||
const secondLayer = firstLayer.with({ responseType: 'blob' });
|
||||
|
||||
describe("when the outter call provides a value", () => {
|
||||
it("should apply it", () => {
|
||||
secondLayer({ responseType: 'text' })
|
||||
expect(mockAxios).toHaveBeenCalledWith({ responseType: 'text' });
|
||||
});
|
||||
});
|
||||
|
||||
describe("when the outter call does not provide a value", () => {
|
||||
it("should use the second layer", () => {
|
||||
secondLayer({ })
|
||||
expect(mockAxios).toHaveBeenCalledWith({ responseType: 'blob' });
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe.each([
|
||||
["params"],
|
||||
["headers"],
|
||||
])('%s', (field) => {
|
||||
const fieldWithValues = (values: any) => {
|
||||
const thing = {} as any;
|
||||
thing[field] = values;
|
||||
return thing;
|
||||
}
|
||||
const base = http2From(mockAxios).with(fieldWithValues({ a: 1, b: 2, c: 3, d: 4 }));
|
||||
|
||||
describe("using default", () => {
|
||||
it("should use the default", () => {
|
||||
base({});
|
||||
expect(mockAxios).toHaveBeenCalledWith(fieldWithValues({ a: 1, b: 2, c: 3, d: 4 }));
|
||||
});
|
||||
});
|
||||
|
||||
describe("overriding", () => {
|
||||
it("should use the override", () => {
|
||||
base(fieldWithValues({ b: 22, e: 5 }));
|
||||
expect(mockAxios).toHaveBeenCalledWith(fieldWithValues({ a: 1, b: 22, c: 3, d: 4, e: 5 }));
|
||||
});
|
||||
});
|
||||
|
||||
describe("wrapping", () => {
|
||||
const firstLayer = base.with(fieldWithValues({ b: 22 }));
|
||||
const secondLayer = firstLayer.with(fieldWithValues({ c: 33 }));
|
||||
|
||||
describe("when the outter call provides a value", () => {
|
||||
it("should apply it", () => {
|
||||
secondLayer(fieldWithValues({ a: 11, e: 5 }));
|
||||
expect(mockAxios).toHaveBeenCalledWith(fieldWithValues({ a: 11, b: 22, c: 33, d: 4, e: 5 }));
|
||||
});
|
||||
});
|
||||
|
||||
describe("when the outter call does not provide a value", () => {
|
||||
it("should use the second layer", () => {
|
||||
secondLayer({ });
|
||||
expect(mockAxios).toHaveBeenCalledWith(fieldWithValues({ a: 1, b: 22, c: 33, d: 4 }));
|
||||
});
|
||||
});
|
||||
});
|
||||
})
|
||||
});
|
||||
@@ -34,7 +34,7 @@ describe("i8n", () => {
|
||||
|
||||
describe("langs", () => {
|
||||
it("should be all langs that are explicitly defined", () => {
|
||||
expect(langs()).toEqual(["en-US", "da-DK", "fr-FR", "nl-NL"]);
|
||||
expect(langs()).toEqual(["en-US", "nl-NL"]);
|
||||
});
|
||||
});
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
import dayjs from "dayjs";
|
||||
import libxmljs from "libxmljs2";
|
||||
import { FixedClock } from "../src/clock";
|
||||
import { xmlTidy } from "../src/utils";
|
||||
|
||||
import {
|
||||
contains,
|
||||
@@ -20,17 +20,17 @@ import {
|
||||
allOf,
|
||||
features,
|
||||
STAR_WARS,
|
||||
NO_FEATURES,
|
||||
} from "../src/icon";
|
||||
|
||||
describe("SvgIcon", () => {
|
||||
const xmlTidy = (xml: string) =>
|
||||
libxmljs.parseXmlString(xml, { noblanks: true, net: false }).toString();
|
||||
|
||||
const svgIcon24 = `<?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>
|
||||
`;
|
||||
|
||||
@@ -61,9 +61,7 @@ describe("SvgIcon", () => {
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="-4 -4 32 32">
|
||||
<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>
|
||||
`)
|
||||
);
|
||||
@@ -112,9 +110,7 @@ describe("SvgIcon", () => {
|
||||
<rect x="0" y="0" width="24" height="24" fill="red"/>
|
||||
<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>
|
||||
`)
|
||||
);
|
||||
@@ -138,9 +134,7 @@ describe("SvgIcon", () => {
|
||||
<rect x="-4" y="-4" width="36" height="36" fill="pink"/>
|
||||
<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>
|
||||
`)
|
||||
);
|
||||
@@ -158,9 +152,7 @@ describe("SvgIcon", () => {
|
||||
<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>
|
||||
`)
|
||||
);
|
||||
@@ -180,9 +172,7 @@ describe("SvgIcon", () => {
|
||||
<rect x="0" y="0" width="24" height="24" fill="red"/>
|
||||
<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>
|
||||
`)
|
||||
);
|
||||
@@ -192,7 +182,7 @@ describe("SvgIcon", () => {
|
||||
|
||||
describe("foreground color", () => {
|
||||
describe("with no viewPort increase", () => {
|
||||
it("should change the fill values", () => {
|
||||
it("should add a rectangle the same size as the original viewPort", () => {
|
||||
expect(
|
||||
new SvgIcon(svgIcon24)
|
||||
.with({ features: { foregroundColor: "red" } })
|
||||
@@ -202,9 +192,7 @@ describe("SvgIcon", () => {
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
|
||||
<path d="path1" fill="red"/>
|
||||
<path d="path2" fill="none" stroke="red"/>
|
||||
<text font-size="25" fill="none" stroke="red">80's</text>
|
||||
<path d="path3" fill="red"/>
|
||||
<text font-size="25" fill="red">80's</text>
|
||||
</svg>
|
||||
`)
|
||||
);
|
||||
@@ -212,7 +200,7 @@ describe("SvgIcon", () => {
|
||||
});
|
||||
|
||||
describe("with a viewPort increase", () => {
|
||||
it("should change the fill values", () => {
|
||||
it("should add a rectangle the same size as the original viewPort", () => {
|
||||
expect(
|
||||
new SvgIcon(svgIcon24)
|
||||
.with({
|
||||
@@ -227,9 +215,7 @@ describe("SvgIcon", () => {
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="-4 -4 32 32">
|
||||
<path d="path1" fill="pink"/>
|
||||
<path d="path2" fill="none" stroke="pink"/>
|
||||
<text font-size="25" fill="none" stroke="pink">80's</text>
|
||||
<path d="path3" fill="pink"/>
|
||||
<text font-size="25" fill="pink">80's</text>
|
||||
</svg>
|
||||
`)
|
||||
);
|
||||
@@ -247,9 +233,7 @@ describe("SvgIcon", () => {
|
||||
<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>
|
||||
`)
|
||||
);
|
||||
@@ -268,51 +252,7 @@ describe("SvgIcon", () => {
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
|
||||
<path d="path1" fill="red"/>
|
||||
<path d="path2" fill="none" stroke="red"/>
|
||||
<text font-size="25" fill="none" stroke="red">80's</text>
|
||||
<path d="path3" fill="red"/>
|
||||
<text font-size="25" fill="red">80's</text>
|
||||
</svg>
|
||||
`)
|
||||
);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe("text", () => {
|
||||
describe("when text value specified", () => {
|
||||
it("should change the text values", () => {
|
||||
expect(
|
||||
new SvgIcon(svgIcon24)
|
||||
.with({ features: { text: "yipppeeee" } })
|
||||
.toString()
|
||||
).toEqual(
|
||||
xmlTidy(`<?xml version="1.0" encoding="UTF-8"?>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
|
||||
<path d="path1"/>
|
||||
<path d="path2" fill="none" stroke="#000"/>
|
||||
<text font-size="25" fill="none">yipppeeee</text>
|
||||
<path d="path3"/>
|
||||
<text font-size="25">yipppeeee</text>
|
||||
</svg>
|
||||
`)
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
describe("of undefined", () => {
|
||||
it("should not do anything", () => {
|
||||
expect(
|
||||
new SvgIcon(svgIcon24)
|
||||
.with({ features: { text: undefined } })
|
||||
.toString()
|
||||
).toEqual(
|
||||
xmlTidy(`<?xml version="1.0" encoding="UTF-8"?>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
|
||||
<path d="path1"/>
|
||||
<path d="path2" fill="none" stroke="#000"/>
|
||||
<text font-size="25" fill="none">80's</text>
|
||||
<path d="path3"/>
|
||||
<text font-size="25">80's</text>
|
||||
</svg>
|
||||
`)
|
||||
);
|
||||
@@ -378,14 +318,10 @@ describe("SvgIcon", () => {
|
||||
|
||||
class DummyIcon implements Icon {
|
||||
svg: string;
|
||||
features: IconFeatures;
|
||||
|
||||
features: Partial<IconFeatures>;
|
||||
constructor(svg: string, features: Partial<IconFeatures>) {
|
||||
this.svg = svg;
|
||||
this.features = {
|
||||
...NO_FEATURES,
|
||||
...features
|
||||
};
|
||||
this.features = features;
|
||||
}
|
||||
|
||||
public apply = (transformer: Transformer): Icon => transformer(this);
|
||||
@@ -414,7 +350,6 @@ describe("transform", () => {
|
||||
viewPortIncreasePercent: 100,
|
||||
foregroundColor: "blue",
|
||||
backgroundColor: "blue",
|
||||
text: "a",
|
||||
},
|
||||
})
|
||||
.apply(
|
||||
@@ -422,7 +357,6 @@ describe("transform", () => {
|
||||
features: {
|
||||
foregroundColor: "override1",
|
||||
backgroundColor: "override2",
|
||||
text: "b",
|
||||
},
|
||||
})
|
||||
) as DummyIcon;
|
||||
@@ -432,7 +366,6 @@ describe("transform", () => {
|
||||
viewPortIncreasePercent: 100,
|
||||
foregroundColor: "override1",
|
||||
backgroundColor: "override2",
|
||||
text: "b",
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -449,7 +382,6 @@ describe("transform", () => {
|
||||
viewPortIncreasePercent: 100,
|
||||
foregroundColor: "blue",
|
||||
backgroundColor: "blue",
|
||||
text: "bob",
|
||||
},
|
||||
})
|
||||
.apply(
|
||||
@@ -463,7 +395,6 @@ describe("transform", () => {
|
||||
viewPortIncreasePercent: 100,
|
||||
foregroundColor: "blue",
|
||||
backgroundColor: "blue",
|
||||
text: "bob"
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -480,7 +411,6 @@ describe("features", () => {
|
||||
viewPortIncreasePercent: 100,
|
||||
foregroundColor: "blue",
|
||||
backgroundColor: "blue",
|
||||
text: "foobar"
|
||||
})
|
||||
) as DummyIcon;
|
||||
|
||||
@@ -488,7 +418,6 @@ describe("features", () => {
|
||||
viewPortIncreasePercent: 100,
|
||||
foregroundColor: "blue",
|
||||
backgroundColor: "blue",
|
||||
text: "foobar"
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
78
tests/images.test.ts
Normal file
@@ -0,0 +1,78 @@
|
||||
|
||||
import tmp from "tmp";
|
||||
import fse from "fs-extra";
|
||||
import path from "path";
|
||||
import { Md5 } from "ts-md5";
|
||||
|
||||
import sharp from "sharp";
|
||||
jest.mock("sharp");
|
||||
|
||||
import { cachingImageFetcher } from "../src/images";
|
||||
|
||||
describe("cachingImageFetcher", () => {
|
||||
const delegate = jest.fn();
|
||||
const url = "http://test.example.com/someimage.jpg";
|
||||
|
||||
beforeEach(() => {
|
||||
jest.clearAllMocks();
|
||||
jest.resetAllMocks();
|
||||
});
|
||||
|
||||
describe("when there is no image in the cache", () => {
|
||||
it("should fetch the image from the source and then cache and return it", async () => {
|
||||
const dir = tmp.dirSync();
|
||||
const cacheFile = path.join(dir.name, `${Md5.hashStr(url)}.png`);
|
||||
const jpgImage = Buffer.from("jpg-image", "utf-8");
|
||||
const pngImage = Buffer.from("png-image", "utf-8");
|
||||
|
||||
delegate.mockResolvedValue({ contentType: "image/jpeg", data: jpgImage });
|
||||
const png = jest.fn();
|
||||
(sharp as unknown as jest.Mock).mockReturnValue({ png });
|
||||
png.mockReturnValue({
|
||||
toBuffer: () => Promise.resolve(pngImage),
|
||||
});
|
||||
|
||||
const result = await cachingImageFetcher(dir.name, delegate)(url);
|
||||
|
||||
expect(result!.contentType).toEqual("image/png");
|
||||
expect(result!.data).toEqual(pngImage);
|
||||
|
||||
expect(delegate).toHaveBeenCalledWith(url);
|
||||
expect(fse.existsSync(cacheFile)).toEqual(true);
|
||||
expect(fse.readFileSync(cacheFile)).toEqual(pngImage);
|
||||
});
|
||||
});
|
||||
|
||||
describe("when the image is already in the cache", () => {
|
||||
it("should fetch the image from the cache and return it", async () => {
|
||||
const dir = tmp.dirSync();
|
||||
const cacheFile = path.join(dir.name, `${Md5.hashStr(url)}.png`);
|
||||
const data = Buffer.from("foobar2", "utf-8");
|
||||
|
||||
fse.writeFileSync(cacheFile, data);
|
||||
|
||||
const result = await cachingImageFetcher(dir.name, delegate)(url);
|
||||
|
||||
expect(result!.contentType).toEqual("image/png");
|
||||
expect(result!.data).toEqual(data);
|
||||
|
||||
expect(delegate).not.toHaveBeenCalled();
|
||||
});
|
||||
});
|
||||
|
||||
describe("when the delegate returns undefined", () => {
|
||||
it("should return undefined", async () => {
|
||||
const dir = tmp.dirSync();
|
||||
const cacheFile = path.join(dir.name, `${Md5.hashStr(url)}.png`);
|
||||
|
||||
delegate.mockResolvedValue(undefined);
|
||||
|
||||
const result = await cachingImageFetcher(dir.name, delegate)(url);
|
||||
|
||||
expect(result).toBeUndefined();
|
||||
|
||||
expect(delegate).toHaveBeenCalledWith(url);
|
||||
expect(fse.existsSync(cacheFile)).toEqual(false);
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -6,6 +6,7 @@ import {
|
||||
MusicLibrary,
|
||||
artistToArtistSummary,
|
||||
albumToAlbumSummary,
|
||||
Artist,
|
||||
} from "../src/music_service";
|
||||
import { v4 as uuid } from "uuid";
|
||||
import {
|
||||
@@ -78,6 +79,11 @@ describe("InMemoryMusicService", () => {
|
||||
musicLibrary = (await service.login(token.serviceToken)) as MusicLibrary;
|
||||
});
|
||||
|
||||
const artistToArtistSummaryWithSortName = (artist: Artist) => ({
|
||||
...artistToArtistSummary(artist),
|
||||
sortName: artist.name
|
||||
})
|
||||
|
||||
describe("artists", () => {
|
||||
const artist1 = anArtist();
|
||||
const artist2 = anArtist();
|
||||
@@ -95,11 +101,11 @@ describe("InMemoryMusicService", () => {
|
||||
await musicLibrary.artists({ _index: 0, _count: 100 })
|
||||
).toEqual({
|
||||
results: [
|
||||
artistToArtistSummary(artist1),
|
||||
artistToArtistSummary(artist2),
|
||||
artistToArtistSummary(artist3),
|
||||
artistToArtistSummary(artist4),
|
||||
artistToArtistSummary(artist5),
|
||||
artistToArtistSummaryWithSortName(artist1),
|
||||
artistToArtistSummaryWithSortName(artist2),
|
||||
artistToArtistSummaryWithSortName(artist3),
|
||||
artistToArtistSummaryWithSortName(artist4),
|
||||
artistToArtistSummaryWithSortName(artist5),
|
||||
],
|
||||
total: 5,
|
||||
});
|
||||
@@ -110,8 +116,8 @@ describe("InMemoryMusicService", () => {
|
||||
it("should provide an array of artists", async () => {
|
||||
expect(await musicLibrary.artists({ _index: 2, _count: 2 })).toEqual({
|
||||
results: [
|
||||
artistToArtistSummary(artist3),
|
||||
artistToArtistSummary(artist4),
|
||||
artistToArtistSummaryWithSortName(artist3),
|
||||
artistToArtistSummaryWithSortName(artist4),
|
||||
],
|
||||
total: 5,
|
||||
});
|
||||
@@ -121,7 +127,7 @@ describe("InMemoryMusicService", () => {
|
||||
describe("fetching the last page", () => {
|
||||
it("should provide an array of artists", async () => {
|
||||
expect(await musicLibrary.artists({ _index: 4, _count: 2 })).toEqual({
|
||||
results: [artistToArtistSummary(artist5)],
|
||||
results: [artistToArtistSummaryWithSortName(artist5)],
|
||||
total: 5,
|
||||
});
|
||||
});
|
||||
|
||||
@@ -62,7 +62,7 @@ export class InMemoryMusicService implements MusicService {
|
||||
|
||||
return Promise.resolve({
|
||||
artists: (q: ArtistQuery) =>
|
||||
Promise.resolve(this.artists.map(artistToArtistSummary))
|
||||
Promise.resolve(this.artists.map(artistToArtistSummary).map(it => ({ ...it, sortName: it.name })))
|
||||
.then(slice2(q))
|
||||
.then(asResult),
|
||||
artist: (id: string) =>
|
||||
@@ -161,9 +161,6 @@ export class InMemoryMusicService implements MusicService {
|
||||
Promise.reject("Unsupported operation"),
|
||||
similarSongs: async (_: string) => Promise.resolve([]),
|
||||
topSongs: async (_: string) => Promise.resolve([]),
|
||||
radioStations: async () => Promise.resolve([]),
|
||||
radioStation: async (_: string) => Promise.reject("Unsupported operation"),
|
||||
years: async () => Promise.resolve([]),
|
||||
});
|
||||
}
|
||||
|
||||
|
||||
@@ -1,7 +1,57 @@
|
||||
import { v4 as uuid } from "uuid";
|
||||
|
||||
import { anArtist } from "./builders";
|
||||
import { artistToArtistSummary } from "../src/music_service";
|
||||
import { artistToArtistSummary, slice2 } from "../src/music_service";
|
||||
|
||||
|
||||
describe("slice2", () => {
|
||||
const things = ["a", "b", "c", "d", "e", "f", "g", "h", "i"];
|
||||
|
||||
describe("when slice is a subset of the things", () => {
|
||||
it("should return the page", () => {
|
||||
expect(slice2({ _index: 3, _count: 4 })(things)).toEqual([
|
||||
["d", "e", "f", "g"],
|
||||
things.length
|
||||
])
|
||||
});
|
||||
});
|
||||
|
||||
describe("when slice goes off the end of the things", () => {
|
||||
it("should return the page", () => {
|
||||
expect(slice2({ _index: 5, _count: 100 })(things)).toEqual([
|
||||
["f", "g", "h", "i"],
|
||||
things.length
|
||||
])
|
||||
});
|
||||
});
|
||||
|
||||
describe("when no _count is provided", () => {
|
||||
it("should return from the index", () => {
|
||||
expect(slice2({ _index: 5 })(things)).toEqual([
|
||||
["f", "g", "h", "i"],
|
||||
things.length
|
||||
])
|
||||
});
|
||||
});
|
||||
|
||||
describe("when no _index is provided", () => {
|
||||
it("should assume from the start", () => {
|
||||
expect(slice2({ _count: 3 })(things)).toEqual([
|
||||
["a", "b", "c"],
|
||||
things.length
|
||||
])
|
||||
});
|
||||
});
|
||||
|
||||
describe("when no _index or _count is provided", () => {
|
||||
it("should return all the things", () => {
|
||||
expect(slice2()(things)).toEqual([
|
||||
things,
|
||||
things.length
|
||||
])
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe("artistToArtistSummary", () => {
|
||||
it("should map fields correctly", () => {
|
||||
|
||||
@@ -94,7 +94,7 @@ class SonosDriver {
|
||||
.get(this.bonobUrl.append({ pathname: "/" }).pathname())
|
||||
.expect(200)
|
||||
.then((response) => {
|
||||
const m = response.text.match(/ action="([^"]+)"/i);
|
||||
const m = response.text.match(/ action="(.*)" /i);
|
||||
return m![1]!;
|
||||
});
|
||||
|
||||
|
||||
@@ -2,7 +2,9 @@ import { v4 as uuid } from "uuid";
|
||||
import dayjs from "dayjs";
|
||||
import request from "supertest";
|
||||
import Image from "image-js";
|
||||
import fs from "fs";
|
||||
import { either as E, taskEither as TE } from "fp-ts";
|
||||
import path from "path";
|
||||
|
||||
import { AuthFailure, MusicService } from "../src/music_service";
|
||||
import makeServer, {
|
||||
@@ -165,13 +167,15 @@ describe("RangeBytesFromFilter", () => {
|
||||
|
||||
|
||||
describe("server", () => {
|
||||
jest.setTimeout(Number.parseInt(process.env["JEST_TIMEOUT"] || "5000"));
|
||||
|
||||
beforeEach(() => {
|
||||
jest.clearAllMocks();
|
||||
jest.resetAllMocks();
|
||||
});
|
||||
|
||||
const bonobUrlWithNoContextPath = url("http://localhost:1234");
|
||||
const bonobUrlWithContextPath = url("http://localhost:1234/aContext");
|
||||
const bonobUrlWithNoContextPath = url("http://bonob.localhost:1234");
|
||||
const bonobUrlWithContextPath = url("http://bonob.localhost:1234/aContext");
|
||||
|
||||
const langName = randomLang();
|
||||
const acceptLanguage = `le-ET,${langName};q=0.9,en;q=0.8`;
|
||||
@@ -240,7 +244,7 @@ describe("server", () => {
|
||||
.send();
|
||||
|
||||
expect(res.status).toEqual(200);
|
||||
expect(res.text).toMatch(new RegExp(`${lang("devices")}.*\\(0\\)`));
|
||||
expect(res.text).toMatch(`<h2>${lang("devices")} \(0\)</h2>`);
|
||||
expect(res.text).not.toMatch(/class=device/);
|
||||
expect(res.text).toContain(lang("noSonosDevices"));
|
||||
});
|
||||
@@ -276,7 +280,7 @@ describe("server", () => {
|
||||
.send();
|
||||
|
||||
expect(res.status).toEqual(200);
|
||||
expect(res.text).toMatch(new RegExp(`${lang("devices")}.*\\(0\\)`));
|
||||
expect(res.text).toMatch(`<h2>${lang("devices")} \(0\)</h2>`);
|
||||
expect(res.text).not.toMatch(/class=device/);
|
||||
expect(res.text).toContain(lang("noSonosDevices"));
|
||||
});
|
||||
@@ -290,7 +294,7 @@ describe("server", () => {
|
||||
.send();
|
||||
|
||||
expect(res.status).toEqual(200);
|
||||
expect(res.text).toMatch(new RegExp(`${lang("services")}.*\\(0\\)`));
|
||||
expect(res.text).toMatch(`<h2>${lang("services")} \(0\)</h2>`);
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -352,9 +356,9 @@ describe("server", () => {
|
||||
.send();
|
||||
|
||||
expect(res.status).toEqual(200);
|
||||
expect(res.text).toMatch(new RegExp(`${lang("devices")}.*\\(2\\)`));
|
||||
expect(res.text).toMatch(/device1.*172\.0\.0\.1:4301/);
|
||||
expect(res.text).toMatch(/device2.*172\.0\.0\.2:4302/);
|
||||
expect(res.text).toMatch(`<h2>${lang("devices")} \(2\)</h2>`);
|
||||
expect(res.text).toMatch(/device1\s+\(172.0.0.1:4301\)/);
|
||||
expect(res.text).toMatch(/device2\s+\(172.0.0.2:4302\)/);
|
||||
});
|
||||
});
|
||||
|
||||
@@ -366,11 +370,11 @@ describe("server", () => {
|
||||
.send();
|
||||
|
||||
expect(res.status).toEqual(200);
|
||||
expect(res.text).toMatch(new RegExp(`${lang("services")}.*\\(4\\)`));
|
||||
expect(res.text).toMatch(/s1.*SID:\s*1/);
|
||||
expect(res.text).toMatch(/s2.*SID:\s*2/);
|
||||
expect(res.text).toMatch(/s3.*SID:\s*3/);
|
||||
expect(res.text).toMatch(/s4.*SID:\s*4/);
|
||||
expect(res.text).toMatch(`<h2>${lang("services")} \(4\)</h2>`);
|
||||
expect(res.text).toMatch(/s1\s+\(1\)/);
|
||||
expect(res.text).toMatch(/s2\s+\(2\)/);
|
||||
expect(res.text).toMatch(/s3\s+\(3\)/);
|
||||
expect(res.text).toMatch(/s4\s+\(4\)/);
|
||||
});
|
||||
});
|
||||
|
||||
@@ -382,11 +386,14 @@ describe("server", () => {
|
||||
.send();
|
||||
expect(res.status).toEqual(200);
|
||||
expect(res.text).toMatch(
|
||||
`<input type="submit" value="${lang("register")}" id="submit">`
|
||||
`<input type="submit" value="${lang("register")}">`
|
||||
);
|
||||
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(
|
||||
`value="${lang("removeRegistration")}"`
|
||||
`<input type="submit" value="${lang("removeRegistration")}">`
|
||||
);
|
||||
});
|
||||
});
|
||||
@@ -437,11 +444,14 @@ describe("server", () => {
|
||||
.send();
|
||||
expect(res.status).toEqual(200);
|
||||
expect(res.text).toMatch(
|
||||
`<input type="submit" value="${lang("register")}" id="submit">`
|
||||
`<input type="submit" value="${lang("register")}">`
|
||||
);
|
||||
expect(res.text).toContain(lang("existingServiceConfig"));
|
||||
expect(res.text).toMatch(`<h3>${lang("expectedConfig")}</h3>`);
|
||||
expect(res.text).toMatch(
|
||||
`<input type="submit" value="${lang("removeRegistration")}" id="submit"`
|
||||
`<h3>${lang("existingServiceConfig")}</h3>`
|
||||
);
|
||||
expect(res.text).toMatch(
|
||||
`<input type="submit" value="${lang("removeRegistration")}">`
|
||||
);
|
||||
});
|
||||
});
|
||||
@@ -626,13 +636,13 @@ describe("server", () => {
|
||||
expect(res.status).toEqual(200);
|
||||
expect(res.text).toMatch(`<title>${lang("login")}</title>`);
|
||||
expect(res.text).toMatch(
|
||||
`<h1>${lang("logInToBonob")}</h1>`
|
||||
`<h1 class="login one-word-per-line">${lang("logInToBonob")}</h1>`
|
||||
);
|
||||
expect(res.text).toMatch(
|
||||
`<label for="username">${lang("username")}</label>`
|
||||
`<label for="username">${lang("username")}:</label>`
|
||||
);
|
||||
expect(res.text).toMatch(
|
||||
`<label for="password">${lang("password")}</label>`
|
||||
`<label for="password">${lang("password")}:</label>`
|
||||
);
|
||||
expect(res.text).toMatch(
|
||||
`<input type="submit" value="${lang("login")}" id="submit">`
|
||||
@@ -747,22 +757,15 @@ describe("server", () => {
|
||||
const trackId = `t-${uuid()}`;
|
||||
const smapiAuthToken: SmapiToken = { token: `token-${uuid()}`, key: `key-${uuid()}` };
|
||||
|
||||
const streamContent = (content: string) => {
|
||||
const self = {
|
||||
destroyed: false,
|
||||
const streamContent = (content: string) => ({
|
||||
pipe: (_: Transform) => {
|
||||
return {
|
||||
pipe: (res: Response) => {
|
||||
res.send(content);
|
||||
}
|
||||
},
|
||||
};
|
||||
},
|
||||
destroy: () => {
|
||||
self.destroyed = true;
|
||||
}
|
||||
};
|
||||
return self;
|
||||
};
|
||||
});
|
||||
|
||||
describe("HEAD requests", () => {
|
||||
describe("when there is no Bearer token", () => {
|
||||
@@ -828,8 +831,6 @@ describe("server", () => {
|
||||
);
|
||||
expect(res.headers["content-length"]).toEqual("123");
|
||||
expect(res.body).toEqual({});
|
||||
|
||||
expect(trackStream.stream.destroyed).toBe(true);
|
||||
});
|
||||
});
|
||||
|
||||
@@ -855,8 +856,6 @@ describe("server", () => {
|
||||
|
||||
expect(res.status).toEqual(404);
|
||||
expect(res.body).toEqual({});
|
||||
|
||||
expect(trackStream.stream.destroyed).toBe(true);
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -919,8 +918,6 @@ describe("server", () => {
|
||||
|
||||
expect(musicLibrary.nowPlaying).not.toHaveBeenCalled();
|
||||
expect(musicLibrary.stream).toHaveBeenCalledWith({ trackId });
|
||||
|
||||
expect(stream.stream.destroyed).toBe(true);
|
||||
});
|
||||
});
|
||||
|
||||
@@ -964,8 +961,6 @@ describe("server", () => {
|
||||
expect(musicService.login).toHaveBeenCalledWith(serviceToken);
|
||||
expect(musicLibrary.nowPlaying).toHaveBeenCalledWith(trackId);
|
||||
expect(musicLibrary.stream).toHaveBeenCalledWith({ trackId });
|
||||
|
||||
expect(stream.stream.destroyed).toBe(true);
|
||||
});
|
||||
});
|
||||
|
||||
@@ -1007,8 +1002,6 @@ describe("server", () => {
|
||||
expect(musicService.login).toHaveBeenCalledWith(serviceToken);
|
||||
expect(musicLibrary.nowPlaying).toHaveBeenCalledWith(trackId);
|
||||
expect(musicLibrary.stream).toHaveBeenCalledWith({ trackId });
|
||||
|
||||
expect(stream.stream.destroyed).toBe(true);
|
||||
});
|
||||
});
|
||||
|
||||
@@ -1049,8 +1042,6 @@ describe("server", () => {
|
||||
expect(musicService.login).toHaveBeenCalledWith(serviceToken);
|
||||
expect(musicLibrary.nowPlaying).toHaveBeenCalledWith(trackId);
|
||||
expect(musicLibrary.stream).toHaveBeenCalledWith({ trackId });
|
||||
|
||||
expect(stream.stream.destroyed).toBe(true);
|
||||
});
|
||||
});
|
||||
|
||||
@@ -1094,8 +1085,6 @@ describe("server", () => {
|
||||
expect(musicService.login).toHaveBeenCalledWith(serviceToken);
|
||||
expect(musicLibrary.nowPlaying).toHaveBeenCalledWith(trackId);
|
||||
expect(musicLibrary.stream).toHaveBeenCalledWith({ trackId });
|
||||
|
||||
expect(stream.stream.destroyed).toBe(true);
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -1144,8 +1133,6 @@ describe("server", () => {
|
||||
trackId,
|
||||
range: requestedRange,
|
||||
});
|
||||
|
||||
expect(stream.stream.destroyed).toBe(true);
|
||||
});
|
||||
});
|
||||
|
||||
@@ -1193,8 +1180,6 @@ describe("server", () => {
|
||||
trackId,
|
||||
range: "4000-5000",
|
||||
});
|
||||
|
||||
expect(stream.stream.destroyed).toBe(true);
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -1315,6 +1300,279 @@ describe("server", () => {
|
||||
});
|
||||
});
|
||||
|
||||
describe("fetching multiple images as a collage", () => {
|
||||
const png = fs.readFileSync(
|
||||
path.join(
|
||||
__dirname,
|
||||
"..",
|
||||
"docs",
|
||||
"images",
|
||||
"chartreuseFuchsia.png"
|
||||
)
|
||||
);
|
||||
|
||||
describe("fetching a collage of 4 when all are available", () => {
|
||||
it("should return the image and a 200", async () => {
|
||||
const urns = [
|
||||
"art:1",
|
||||
"art:2",
|
||||
"art:3",
|
||||
"art:4",
|
||||
].map(resource => ({ system:"subsonic", resource }));
|
||||
|
||||
musicService.login.mockResolvedValue(musicLibrary);
|
||||
|
||||
urns.forEach((_) => {
|
||||
musicLibrary.coverArt.mockResolvedValueOnce(
|
||||
coverArtResponse({
|
||||
data: png,
|
||||
})
|
||||
);
|
||||
});
|
||||
|
||||
const res = await request(server)
|
||||
.get(
|
||||
`/art/${urns.map(it => encodeURIComponent(formatForURL(it))).join(
|
||||
"&"
|
||||
)}/size/200?${BONOB_ACCESS_TOKEN_HEADER}=${apiToken}`
|
||||
)
|
||||
.set(BONOB_ACCESS_TOKEN_HEADER, apiToken);
|
||||
|
||||
expect(res.status).toEqual(200);
|
||||
expect(res.header["content-type"]).toEqual("image/png");
|
||||
|
||||
expect(musicService.login).toHaveBeenCalledWith(serviceToken);
|
||||
urns.forEach((it) => {
|
||||
expect(musicLibrary.coverArt).toHaveBeenCalledWith(it, 200);
|
||||
});
|
||||
|
||||
const image = await Image.load(res.body);
|
||||
expect(image.width).toEqual(200);
|
||||
expect(image.height).toEqual(200);
|
||||
});
|
||||
});
|
||||
|
||||
describe("fetching a collage of 4, however only 1 is available", () => {
|
||||
it("should return the single image", async () => {
|
||||
const urns = ["art:1", "art:2", "art:3", "art:4"].map(resource => ({ system:"subsonic", resource }));
|
||||
|
||||
musicService.login.mockResolvedValue(musicLibrary);
|
||||
|
||||
musicLibrary.coverArt.mockResolvedValueOnce(undefined);
|
||||
musicLibrary.coverArt.mockResolvedValueOnce(undefined);
|
||||
musicLibrary.coverArt.mockResolvedValueOnce(undefined);
|
||||
musicLibrary.coverArt.mockResolvedValueOnce(
|
||||
coverArtResponse({
|
||||
data: png,
|
||||
contentType: "image/some-mime-type",
|
||||
})
|
||||
);
|
||||
|
||||
const res = await request(server)
|
||||
.get(
|
||||
`/art/${urns.map(it => encodeURIComponent(formatForURL(it))).join(
|
||||
"&"
|
||||
)}/size/200?${BONOB_ACCESS_TOKEN_HEADER}=${apiToken}`
|
||||
)
|
||||
.set(BONOB_ACCESS_TOKEN_HEADER, apiToken);
|
||||
|
||||
expect(res.status).toEqual(200);
|
||||
expect(res.header["content-type"]).toEqual(
|
||||
"image/some-mime-type"
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
describe("fetching a collage of 4 and all are missing", () => {
|
||||
it("should return a 404", async () => {
|
||||
const urns = ["art:1", "art:2", "art:3", "art:4"].map(resource => ({ system:"subsonic", resource }));
|
||||
|
||||
musicService.login.mockResolvedValue(musicLibrary);
|
||||
|
||||
urns.forEach((_) => {
|
||||
musicLibrary.coverArt.mockResolvedValueOnce(undefined);
|
||||
});
|
||||
|
||||
const res = await request(server)
|
||||
.get(
|
||||
`/art/${urns.map(it => encodeURIComponent(formatForURL(it))).join(
|
||||
"&"
|
||||
)}/size/200?${BONOB_ACCESS_TOKEN_HEADER}=${apiToken}`
|
||||
)
|
||||
.set(BONOB_ACCESS_TOKEN_HEADER, apiToken);
|
||||
|
||||
expect(res.status).toEqual(404);
|
||||
});
|
||||
});
|
||||
|
||||
describe("fetching a collage of 9 when all are available", () => {
|
||||
it("should return the image and a 200", async () => {
|
||||
const urns = [
|
||||
"artist:1",
|
||||
"artist:2",
|
||||
"coverArt:3",
|
||||
"artist:4",
|
||||
"artist:5",
|
||||
"artist:6",
|
||||
"artist:7",
|
||||
"artist:8",
|
||||
"artist:9",
|
||||
].map(resource => ({ system:"subsonic", resource }));
|
||||
|
||||
musicService.login.mockResolvedValue(musicLibrary);
|
||||
|
||||
urns.forEach((_) => {
|
||||
musicLibrary.coverArt.mockResolvedValueOnce(
|
||||
coverArtResponse({
|
||||
data: png,
|
||||
})
|
||||
);
|
||||
});
|
||||
|
||||
const res = await request(server)
|
||||
.get(
|
||||
`/art/${urns.map(it => encodeURIComponent(formatForURL(it))).join(
|
||||
"&"
|
||||
)}/size/180?${BONOB_ACCESS_TOKEN_HEADER}=${apiToken}`
|
||||
)
|
||||
.set(BONOB_ACCESS_TOKEN_HEADER, apiToken);
|
||||
|
||||
expect(res.status).toEqual(200);
|
||||
expect(res.header["content-type"]).toEqual("image/png");
|
||||
|
||||
expect(musicService.login).toHaveBeenCalledWith(serviceToken);
|
||||
urns.forEach((it) => {
|
||||
expect(musicLibrary.coverArt).toHaveBeenCalledWith(it, 180);
|
||||
});
|
||||
|
||||
const image = await Image.load(res.body);
|
||||
expect(image.width).toEqual(180);
|
||||
expect(image.height).toEqual(180);
|
||||
});
|
||||
});
|
||||
|
||||
describe("fetching a collage of 9 when only 2 are available", () => {
|
||||
it("should still return an image and a 200", async () => {
|
||||
const urns = [
|
||||
"artist:1",
|
||||
"artist:2",
|
||||
"artist:3",
|
||||
"artist:4",
|
||||
"artist:5",
|
||||
"artist:6",
|
||||
"artist:7",
|
||||
"artist:8",
|
||||
"artist:9",
|
||||
].map(resource => ({ system:"subsonic", resource }));
|
||||
|
||||
musicService.login.mockResolvedValue(musicLibrary);
|
||||
|
||||
musicLibrary.coverArt.mockResolvedValueOnce(
|
||||
coverArtResponse({
|
||||
data: png,
|
||||
})
|
||||
);
|
||||
musicLibrary.coverArt.mockResolvedValueOnce(
|
||||
coverArtResponse({
|
||||
data: png,
|
||||
})
|
||||
);
|
||||
musicLibrary.coverArt.mockResolvedValueOnce(undefined);
|
||||
musicLibrary.coverArt.mockResolvedValueOnce(undefined);
|
||||
musicLibrary.coverArt.mockResolvedValueOnce(undefined);
|
||||
musicLibrary.coverArt.mockResolvedValueOnce(undefined);
|
||||
musicLibrary.coverArt.mockResolvedValueOnce(undefined);
|
||||
musicLibrary.coverArt.mockResolvedValueOnce(undefined);
|
||||
musicLibrary.coverArt.mockResolvedValueOnce(undefined);
|
||||
|
||||
const res = await request(server)
|
||||
.get(
|
||||
`/art/${urns.map(it => encodeURIComponent(formatForURL(it))).join(
|
||||
"&"
|
||||
)}/size/180?${BONOB_ACCESS_TOKEN_HEADER}=${apiToken}`
|
||||
)
|
||||
.set(BONOB_ACCESS_TOKEN_HEADER, apiToken);
|
||||
|
||||
expect(res.status).toEqual(200);
|
||||
expect(res.header["content-type"]).toEqual("image/png");
|
||||
|
||||
expect(musicService.login).toHaveBeenCalledWith(serviceToken);
|
||||
urns.forEach((urn) => {
|
||||
expect(musicLibrary.coverArt).toHaveBeenCalledWith(urn, 180);
|
||||
});
|
||||
|
||||
const image = await Image.load(res.body);
|
||||
expect(image.width).toEqual(180);
|
||||
expect(image.height).toEqual(180);
|
||||
});
|
||||
});
|
||||
|
||||
describe("fetching a collage of 11", () => {
|
||||
it("should still return an image and a 200, though will only display 9", async () => {
|
||||
const urns = [
|
||||
"artist:1",
|
||||
"artist:2",
|
||||
"artist:3",
|
||||
"artist:4",
|
||||
"artist:5",
|
||||
"artist:6",
|
||||
"artist:7",
|
||||
"artist:8",
|
||||
"artist:9",
|
||||
"artist:10",
|
||||
"artist:11",
|
||||
].map(resource => ({ system:"subsonic", resource }));
|
||||
|
||||
musicService.login.mockResolvedValue(musicLibrary);
|
||||
|
||||
urns.forEach((_) => {
|
||||
musicLibrary.coverArt.mockResolvedValueOnce(
|
||||
coverArtResponse({
|
||||
data: png,
|
||||
})
|
||||
);
|
||||
});
|
||||
|
||||
const res = await request(server)
|
||||
.get(
|
||||
`/art/${urns.map(it => encodeURIComponent(formatForURL(it))).join(
|
||||
"&"
|
||||
)}/size/180?${BONOB_ACCESS_TOKEN_HEADER}=${apiToken}`
|
||||
)
|
||||
.set(BONOB_ACCESS_TOKEN_HEADER, apiToken);
|
||||
|
||||
expect(res.status).toEqual(200);
|
||||
expect(res.header["content-type"]).toEqual("image/png");
|
||||
|
||||
expect(musicService.login).toHaveBeenCalledWith(serviceToken);
|
||||
urns.forEach((it) => {
|
||||
expect(musicLibrary.coverArt).toHaveBeenCalledWith(it, 180);
|
||||
});
|
||||
|
||||
const image = await Image.load(res.body);
|
||||
expect(image.width).toEqual(180);
|
||||
expect(image.height).toEqual(180);
|
||||
});
|
||||
});
|
||||
|
||||
describe("when the image is not available", () => {
|
||||
it("should return a 404", async () => {
|
||||
const coverArtURN = { system:"subsonic", resource:"art:404"};
|
||||
|
||||
musicService.login.mockResolvedValue(musicLibrary);
|
||||
musicLibrary.coverArt.mockResolvedValue(undefined);
|
||||
|
||||
const res = await request(server)
|
||||
.get(
|
||||
`/art/${encodeURIComponent(formatForURL(coverArtURN))}/size/180?${BONOB_ACCESS_TOKEN_HEADER}=${apiToken}`
|
||||
)
|
||||
.set(BONOB_ACCESS_TOKEN_HEADER, apiToken);
|
||||
|
||||
expect(res.status).toEqual(404);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe("when there is an error", () => {
|
||||
it("should return a 500", async () => {
|
||||
musicService.login.mockResolvedValue(musicLibrary);
|
||||
@@ -1360,25 +1618,11 @@ describe("server", () => {
|
||||
"..%2F..%2Ffoo",
|
||||
"%2Fetc%2Fpasswd",
|
||||
".%2Fbob.js",
|
||||
"%23%24",
|
||||
].forEach((type) => {
|
||||
describe(`trying to retrieve an icon with name ${type}`, () => {
|
||||
it(`should fail`, async () => {
|
||||
const response = await request(server()).get(
|
||||
`/icon/${type}/size/legacy`
|
||||
);
|
||||
|
||||
expect(response.status).toEqual(400);
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe("missing icons", () => {
|
||||
[
|
||||
".",
|
||||
"..",
|
||||
"1",
|
||||
"%23%24",
|
||||
"notAValidIcon",
|
||||
"notAValidIcon:withSomeText"
|
||||
].forEach((type) => {
|
||||
describe(`trying to retrieve an icon with name ${type}`, () => {
|
||||
it(`should fail`, async () => {
|
||||
@@ -1406,20 +1650,6 @@ describe("server", () => {
|
||||
});
|
||||
});
|
||||
|
||||
describe("invalid text", () => {
|
||||
["..", "foobar.123", "_dog_", "{ whoop }"].forEach((text) => {
|
||||
describe(`trying to retrieve an icon with text ${text}`, () => {
|
||||
it(`should fail`, async () => {
|
||||
const response = await request(server()).get(
|
||||
`/icon/yyyy:${text}/size/60`
|
||||
);
|
||||
|
||||
expect(response.status).toEqual(400);
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe("fetching", () => {
|
||||
[
|
||||
"artists",
|
||||
@@ -1549,41 +1779,6 @@ describe("server", () => {
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe("specifing some text", () => {
|
||||
const text = "somethingWicked"
|
||||
|
||||
describe(`legacy icon`, () => {
|
||||
it("should return the png image", async () => {
|
||||
const response = await request(server()).get(
|
||||
`/icon/yyyy:${text}/size/legacy`
|
||||
);
|
||||
|
||||
expect(response.status).toEqual(200);
|
||||
expect(response.header["content-type"]).toEqual("image/png");
|
||||
const image = await Image.load(response.body);
|
||||
expect(image.width).toEqual(80);
|
||||
expect(image.height).toEqual(80);
|
||||
});
|
||||
});
|
||||
|
||||
describe("svg icon", () => {
|
||||
it(`should return an svg image with the text replaced`, async () => {
|
||||
const response = await request(server()).get(
|
||||
`/icon/yyyy:${text}/size/60`
|
||||
);
|
||||
|
||||
expect(response.status).toEqual(200);
|
||||
expect(response.header["content-type"]).toEqual(
|
||||
"image/svg+xml; charset=utf-8"
|
||||
);
|
||||
const svg = Buffer.from(response.body).toString();
|
||||
expect(svg).toContain(
|
||||
`>${text}</text>`
|
||||
);
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
@@ -1,234 +0,0 @@
|
||||
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();
|
||||
});
|
||||
});
|
||||
});
|
||||
4713
tests/subsonic/generic.test.ts
Normal file
78
tests/subsonic/navidrome.test.ts
Normal file
@@ -0,0 +1,78 @@
|
||||
import { v4 as uuid } from "uuid";
|
||||
import { DODGY_IMAGE_NAME } from "../../src/subsonic";
|
||||
import { artistImageURN } from "../../src/subsonic/generic";
|
||||
import { artistSummaryFromNDArtist } from "../../src/subsonic/navidrome";
|
||||
|
||||
|
||||
describe("artistSummaryFromNDArtist", () => {
|
||||
describe("when the orderArtistName is undefined", () => {
|
||||
it("should use name", () => {
|
||||
const artist = {
|
||||
id: uuid(),
|
||||
name: `name ${uuid()}`,
|
||||
orderArtistName: undefined,
|
||||
largeImageUrl: 'http://example.com/something.jpg'
|
||||
}
|
||||
expect(artistSummaryFromNDArtist(artist)).toEqual({
|
||||
id: artist.id,
|
||||
name: artist.name,
|
||||
sortName: artist.name,
|
||||
image: artistImageURN({ artistId: artist.id, artistImageURL: artist.largeImageUrl })
|
||||
})
|
||||
});
|
||||
});
|
||||
|
||||
describe("when the artist image is valid", () => {
|
||||
it("should create an ArtistSummary with Sortable", () => {
|
||||
const artist = {
|
||||
id: uuid(),
|
||||
name: `name ${uuid()}`,
|
||||
orderArtistName: `orderArtistName ${uuid()}`,
|
||||
largeImageUrl: 'http://example.com/something.jpg'
|
||||
}
|
||||
expect(artistSummaryFromNDArtist(artist)).toEqual({
|
||||
id: artist.id,
|
||||
name: artist.name,
|
||||
sortName: artist.orderArtistName,
|
||||
image: artistImageURN({ artistId: artist.id, artistImageURL: artist.largeImageUrl })
|
||||
})
|
||||
});
|
||||
});
|
||||
|
||||
describe("when the artist image is not valid", () => {
|
||||
it("should create an ArtistSummary with Sortable", () => {
|
||||
const artist = {
|
||||
id: uuid(),
|
||||
name: `name ${uuid()}`,
|
||||
orderArtistName: `orderArtistName ${uuid()}`,
|
||||
largeImageUrl: `http://example.com/${DODGY_IMAGE_NAME}`
|
||||
}
|
||||
|
||||
expect(artistSummaryFromNDArtist(artist)).toEqual({
|
||||
id: artist.id,
|
||||
name: artist.name,
|
||||
sortName: artist.orderArtistName,
|
||||
image: artistImageURN({ artistId: artist.id, artistImageURL: artist.largeImageUrl })
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe("when the artist image is missing", () => {
|
||||
it("should create an ArtistSummary with Sortable", () => {
|
||||
const artist = {
|
||||
id: uuid(),
|
||||
name: `name ${uuid()}`,
|
||||
orderArtistName: `orderArtistName ${uuid()}`,
|
||||
largeImageUrl: undefined
|
||||
}
|
||||
|
||||
expect(artistSummaryFromNDArtist(artist)).toEqual({
|
||||
id: artist.id,
|
||||
name: artist.name,
|
||||
sortName: artist.orderArtistName,
|
||||
image: artistImageURN({ artistId: artist.id, artistImageURL: artist.largeImageUrl })
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
@@ -1,4 +1,50 @@
|
||||
import { takeWithRepeats } from "../src/utils";
|
||||
import { asURLSearchParams, mask, takeWithRepeats } from "../src/utils";
|
||||
|
||||
describe("asURLSearchParams", () => {
|
||||
describe("empty q", () => {
|
||||
it("should return empty params", () => {
|
||||
const q = {};
|
||||
const expected = new URLSearchParams();
|
||||
expect(asURLSearchParams(q)).toEqual(expected);
|
||||
});
|
||||
});
|
||||
|
||||
describe("singular params", () => {
|
||||
it("should append each", () => {
|
||||
const q = {
|
||||
a: 1,
|
||||
b: "bee",
|
||||
c: false,
|
||||
d: true,
|
||||
};
|
||||
const expected = new URLSearchParams();
|
||||
expected.append("a", "1");
|
||||
expected.append("b", "bee");
|
||||
expected.append("c", "false");
|
||||
expected.append("d", "true");
|
||||
|
||||
expect(asURLSearchParams(q)).toEqual(expected);
|
||||
});
|
||||
});
|
||||
|
||||
describe("list params", () => {
|
||||
it("should append each", () => {
|
||||
const q = {
|
||||
a: [1, "two", false, true],
|
||||
b: "yippee",
|
||||
};
|
||||
|
||||
const expected = new URLSearchParams();
|
||||
expected.append("a", "1");
|
||||
expected.append("a", "two");
|
||||
expected.append("a", "false");
|
||||
expected.append("a", "true");
|
||||
expected.append("b", "yippee");
|
||||
|
||||
expect(asURLSearchParams(q)).toEqual(expected);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe("takeWithRepeat", () => {
|
||||
describe("when there is nothing in the input", () => {
|
||||
@@ -29,7 +75,32 @@ describe("takeWithRepeat", () => {
|
||||
describe("when there more than the amount required", () => {
|
||||
it("should return the first n items", () => {
|
||||
expect(takeWithRepeats(["a", "b", "c"], 2)).toEqual(["a", "b"]);
|
||||
expect(takeWithRepeats(["a", undefined, "c"], 2)).toEqual(["a", undefined]);
|
||||
expect(takeWithRepeats(["a", undefined, "c"], 2)).toEqual([
|
||||
"a",
|
||||
undefined,
|
||||
]);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe("mask", () => {
|
||||
it.each([
|
||||
[{}, ["a", "b"], {}],
|
||||
[{ foo: "bar" }, ["a", "b"], { foo: "bar" }],
|
||||
[{ a: 1 }, ["a", "b"], { a: "****" }],
|
||||
[{ a: 1, b: "dog" }, ["a", "b"], { a: "****", b: "****" }],
|
||||
[
|
||||
{ a: 1, b: "dog", foo: "bar" },
|
||||
["a", "b"],
|
||||
{ a: "****", b: "****", foo: "bar" },
|
||||
],
|
||||
])(
|
||||
"masking of %s, keys = %s, should result in %s",
|
||||
(original: any, keys: string[], expected: any) => {
|
||||
const copyOfOrig = JSON.parse(JSON.stringify(original));
|
||||
const masked = mask(original, keys);
|
||||
expect(masked).toEqual(expected);
|
||||
expect(original).toEqual(copyOfOrig);
|
||||
}
|
||||
);
|
||||
});
|
||||
|
||||
@@ -50,7 +50,7 @@
|
||||
// "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */
|
||||
"typeRoots": [
|
||||
"./typings",
|
||||
"./node_modules/@types"
|
||||
"node_modules/@types"
|
||||
]
|
||||
/* List of folders to include type definitions from. */,
|
||||
// "types": ["src/customTypes/scale-that-svg.d.ts"], /* Type declaration files to be included in compilation. */
|
||||
|
||||
@@ -1,4 +0,0 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
|
||||
<path d="M20 6H8.3l8.26-3.34L15.88 1 3.24 6.15C2.51 6.43 2 7.17 2 8v12c0 1.1.89 2 2 2h16c1.11 0 2-.9 2-2V8c0-1.11-.89-2-2-2zm0 2v3h-2V9h-2v2H4V8h16zM4 20v-7h16v7H4z"></path>
|
||||
<circle cx="8" cy="16.48" r="2.5"></circle>
|
||||
</svg>
|
||||
|
Before Width: | Height: | Size: 293 B |
@@ -1,3 +0,0 @@
|
||||
<svg viewBox="0 0 100 100" xmlns="http://www.w3.org/2000/svg">
|
||||
<text x="50" y="75" font-size="65" text-anchor="middle" font-family="Arial, sans-serif" font-weight="bold">80s</text>
|
||||
</svg>
|
||||
|
Before Width: | Height: | Size: 189 B |
@@ -1,3 +0,0 @@
|
||||
<svg viewBox="0 0 100 100" xmlns="http://www.w3.org/2000/svg">
|
||||
<text x="50" y="65" font-size="35" text-anchor="middle" font-family="Arial, sans-serif" font-weight="bold">1980</text>
|
||||
</svg>
|
||||
|
Before Width: | Height: | Size: 190 B |
@@ -1,12 +1,6 @@
|
||||
<% layout('./layout', { title: it.lang("failure") }) %>
|
||||
|
||||
<div id="content">
|
||||
<div class="message-container">
|
||||
<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>
|
||||
<h1 class="failure"><%= it.message %></h1>
|
||||
<h1 class="cause"><%= it.cause || "" %></h1>
|
||||
</div>
|
||||
@@ -1,61 +1,45 @@
|
||||
<% layout('./layout') %>
|
||||
|
||||
<div id="content" class="index-content">
|
||||
<div style="text-align:right;color:#999;font-size:0.85rem;margin-bottom:20px"><%= it.version %></div>
|
||||
<div class="logo">🎵</div>
|
||||
<h1><%= it.bonobService.name %></h1>
|
||||
<p style="color:#999;margin-bottom:30px">Service ID: <%= it.bonobService.sid %></p>
|
||||
|
||||
<div id="content">
|
||||
<div width="100%" style="text-align:right;color:grey"><%= it.version %></div>
|
||||
<h1><%= it.bonobService.name %> (<%= it.bonobService.sid %>)</h1>
|
||||
<h3><%= it.lang("expectedConfig") %></h3>
|
||||
<div><%= JSON.stringify(it.bonobService) %></div>
|
||||
<br/>
|
||||
<% if(it.devices.length > 0) { %>
|
||||
<form action="<%= it.createRegistrationRoute %>" method="POST" style="margin-bottom:30px">
|
||||
<input type="submit" value="<%= it.lang("register") %>" id="submit">
|
||||
<form action="<%= it.createRegistrationRoute %>" method="POST">
|
||||
<input type="submit" value="<%= it.lang("register") %>">
|
||||
</form>
|
||||
<br/>
|
||||
<% } else { %>
|
||||
<p style="color:#dc3545;font-weight:600;margin:30px 0"><%= it.lang("noSonosDevices") %></p>
|
||||
<h3><%= it.lang("noSonosDevices") %></h3>
|
||||
<br/>
|
||||
<% } %>
|
||||
|
||||
<% if(it.registeredBonobService) { %>
|
||||
<div style="margin:20px 0;padding:15px;background:#f8f9fa;border-radius:8px">
|
||||
<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>
|
||||
<h3><%= it.lang("existingServiceConfig") %></h3>
|
||||
<div><%= JSON.stringify(it.registeredBonobService) %></div>
|
||||
<% } else { %>
|
||||
<p style="color:#999;margin:20px 0"><%= it.lang("noExistingServiceRegistration") %></p>
|
||||
<h3><%= it.lang("noExistingServiceRegistration") %></h3>
|
||||
<% } %>
|
||||
|
||||
<% if(it.registeredBonobService) { %>
|
||||
<form action="<%= it.removeRegistrationRoute %>" method="POST" style="margin:20px 0">
|
||||
<input type="submit" value="<%= it.lang("removeRegistration") %>" id="submit" style="background:#dc3545">
|
||||
<br/>
|
||||
<form action="<%= it.removeRegistrationRoute %>" method="POST">
|
||||
<input type="submit" value="<%= it.lang("removeRegistration") %>">
|
||||
</form>
|
||||
<% } %>
|
||||
|
||||
<div style="margin-top:40px;padding-top:30px;border-top:2px solid #e0e0e0">
|
||||
<h2 style="font-size:1.5rem;margin-bottom:15px"><%= it.lang("devices") %> (<%= it.devices.length %>)</h2>
|
||||
<% if(it.devices.length > 0) { %>
|
||||
<ul style="list-style:none;text-align:left;padding:0">
|
||||
<br/>
|
||||
<h2><%= it.lang("devices") %> (<%= it.devices.length %>)</h2>
|
||||
<ul>
|
||||
<% it.devices.forEach(function(d){ %>
|
||||
<li style="padding:10px;margin:5px 0;background:#f8f9fa;border-radius:6px">
|
||||
<strong><%= d.name %></strong> <span style="color:#999">(<%= d.ip %>:<%= d.port %>)</span>
|
||||
</li>
|
||||
<li><%= d.name %> (<%= d.ip %>:<%= d.port %>)</li>
|
||||
<% }) %>
|
||||
</ul>
|
||||
<% } else { %>
|
||||
<p style="color:#999">No devices found</p>
|
||||
<% } %>
|
||||
</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">
|
||||
<h2><%= it.lang("services") %> (<%= it.services.length %>)</h2>
|
||||
<ul>
|
||||
<% 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>
|
||||
<li><%= s.name %> (<%= s.sid %>)</li>
|
||||
<% }) %>
|
||||
</ul>
|
||||
<% } else { %>
|
||||
<p style="color:#999">No services registered</p>
|
||||
<% } %>
|
||||
</div>
|
||||
</div>
|
||||
@@ -1,189 +1,46 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title><%= it.title || "bonob" %></title>
|
||||
<style>
|
||||
* {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
box-sizing: border-box;
|
||||
}
|
||||
|
||||
body {
|
||||
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 {
|
||||
background: white;
|
||||
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);
|
||||
}
|
||||
margin: auto;
|
||||
width: 60%;
|
||||
}
|
||||
|
||||
h1 {
|
||||
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;
|
||||
font-size: 700%;
|
||||
}
|
||||
|
||||
label {
|
||||
font-size: 0.95rem;
|
||||
font-weight: 600;
|
||||
color: #555;
|
||||
margin-left: 5px;
|
||||
font-size: 300%;
|
||||
}
|
||||
|
||||
input[type="text"],
|
||||
input[type="password"] {
|
||||
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 {
|
||||
font-size: 300%;
|
||||
width: 80%;
|
||||
}
|
||||
|
||||
input#submit {
|
||||
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);
|
||||
margin-top: 100px
|
||||
}
|
||||
|
||||
input#submit:hover {
|
||||
transform: translateY(-2px);
|
||||
box-shadow: 0 6px 20px rgba(102, 126, 234, 0.5);
|
||||
.one-word-per-line {
|
||||
word-spacing: 100000px;
|
||||
}
|
||||
|
||||
input#submit:active {
|
||||
transform: translateY(0);
|
||||
}
|
||||
|
||||
.logo {
|
||||
text-align: center;
|
||||
margin-bottom: 20px;
|
||||
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;
|
||||
}
|
||||
.login{
|
||||
width: min-intrinsic;
|
||||
width: -webkit-min-content;
|
||||
width: -moz-min-content;
|
||||
width: min-content;
|
||||
display: table-caption;
|
||||
display: -ms-grid;
|
||||
-ms-grid-columns: min-content;
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
|
||||
@@ -1,17 +1,12 @@
|
||||
<% layout('./layout', { title: it.lang("login") }) %>
|
||||
|
||||
<div id="content">
|
||||
<div class="logo">🎵</div>
|
||||
<h1><%= it.lang("logInToBonob") %></h1>
|
||||
<h1 class="login one-word-per-line"><%= it.lang("logInToBonob") %></h1>
|
||||
<form action="<%= it.loginRoute %>" method="POST">
|
||||
<div class="form-group">
|
||||
<label for="username"><%= it.lang("username") %></label>
|
||||
<input type="text" id="username" name="username" required autofocus>
|
||||
</div>
|
||||
<div class="form-group">
|
||||
<label for="password"><%= it.lang("password") %></label>
|
||||
<input type="password" id="password" name="password" required>
|
||||
</div>
|
||||
<label for="username"><%= it.lang("username") %>:</label><br>
|
||||
<input type="text" id="username" name="username"><br><br>
|
||||
<label for="password"><%= it.lang("password") %>:</label><br>
|
||||
<input type="password" id="password" name="password"><br>
|
||||
<input type="hidden" name="linkCode" value="<%= it.linkCode %>">
|
||||
<input type="submit" value="<%= it.lang("login") %>" id="submit">
|
||||
</form>
|
||||
|
||||
@@ -1,9 +1,5 @@
|
||||
<% layout('./layout', { title: it.lang("success") }) %>
|
||||
|
||||
<div id="content">
|
||||
<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>
|
||||
<h1 class="success"><%= it.message %></h1>
|
||||
</div>
|
||||