What's New?

UI Improvements and Now Playing

When a Source player state is detected a "Now Playing" player will render in the Source card showing how MS tracks plays for scrobbling.

The UI has been reworked to reduce whitespace, compact the layout, use headers more effectively, and improve wording/visualization.

Recently played tracks are now linked to their source (Spotify, Maloja) if MS can parse them.

Backend Tests and Scrobbling Fixes

A suite of tests have been added to test core backend functionality. These tests helped surface multiple bugs that should, now fixed, reduce duplicate scrobbles and improve consistency for all sources/clients.

Other Notable Improvements and Fixes

• Backlog on startup is configurable #100
  • In a source config options property use "scrobbleBacklog": false to disable backlogging on startup
• Enable/disable configs via property
  • In a source/client config at the top level use "enable": false" to disable using that config
• Scrobbling deferred until track finishes playing or is changed
  • This ensures an accurate "listened to" time is recorded for the scrobble, rather than scrobbling as soon as "listened to" time is valid
  • "listened to" is now sent in Maloja scrobble payload
• Jellyfin endpoint now accepts more header content-type values #101
• Updated youtube source library to work better with non-chromium browsers #98

Breaking Changes

Docker Image Base Updated (Linuxserver.io)

• Updates alpine 3.17 -> 3.18
    * Main reason is to potentially fix DNS issues related to musl #88
    * Bumps npm 9.1.2 -> 9.6.6

If you are using Portainer to manage containers you should remove all non-MS related ENVs from the container template before pulling the latest image.

Increased Scrobble Threshold Defaults #73

Previously, the default settings for scrobbling a track specified to scrobble if it was played for more than 30 seconds. This has been increased to:

• Played more than 240 seconds (4 minutes) OR
• More than 50% of the track played (for sources that support reporting track duration)

If you have scrobbleThresholds set in config.json or in individual source configs this does not affect you.

Increased Default Polling Interval

Due to the above change the default polling interval for sources have been adjusted like so:

• Default Interval: 30s -> 10s
• Max Interval: 60s -> 30s

This provides more accurate "listened to" recording and, generally, better source tracking resolution. This should not adversely affect your usage of each provider other than increasing bandwidth a little. These default settings can be overridden using the interval and maxInterval properties in individual source configs.

Changelog

Bug Fixes

• (backend) Fix how port is determined and used for localUrl
• (deezer) Fix deezer passport generation
• (docker) Normalize ownership of node_modules files
• (flatpak) Add missing release node
• (jellyfin) Enable parsing requests with more content-types and add logging on invalid types
• (player) Fix some bugs and add param for easier testing
• (player state) Fix stale/dead logic checks
• (scrobble) Fix config destructing default value
• (scrobble) Fix wrong artists used for comparison
• (scrobble) Fix not using reference duration for fuzzy comparison
• (scrobblers) Test auth when client completes auth callback
• (ui) Use normal match parameters
• (ui) Log line parsing missing line terminator capture
• (ui) Fix wrong route for client auth #97
• (ui) Remove duration percent display when duration is zero
• (ui) For non-polling sources use last activity date for status
• (youtube) Use updated yt music library #98
• (No Category) Load variables from .env for backend
• (No Category) Pass localUrl to scrobble clients for use by lastfm
• (No Category) Fix missing destructure default value

Documentation

• (jellyfin) Add request header workaround for jellyfin #101
• (No Category) Update dashboard screenshot
• (No Category) Clarify subsonic api compatibility

Features

• (config) Implement property to control whether a source/client is used
• (jellyfin) Initial testing suite
• (lastfm) Add player support
• (listenbrainz) Add player support #74
• (maloja) Generate web links for scrobbled tracks
• (maloja) Add listened duration to scrobble payload
• (player) Add sourceOfTruth variable to control logging and future use
• (player) Defer play discovery so listenedFor is accurate
• (player) Log when play fails discovery on player change
• (player) Implement seek and repeat detection
• (player state) Preserve position when player is not in stopped status
• (player state) Implement player status and listened duration in UI
• (scrobble) Use new string approach for track
• (scrobble) Use new string approach for artists
• (scrobble) Implement artist dup bonus scoring heuristic
• (scrobble) Initial scrobble queue implementation
• (scrobble) Implement dead letter queue processing
• (scrobble) Implement heartbeat task for scrobblers
• (scrobble) Improve existing scrobble comparison logic
• (source) Control backlogging via config #100
• (ui) Remove player when dead
• (ui) Compact ui
• (ui) Make player dates human friendly
• (ui) Remove unnecessary wording for track stats
• (ui) Expand displayed plays
• (ui) Implement status indicator
• (No Category) Rework source api to include player states
• (No Category) BREAKING Set default scrobble thresholds to standard values #73
• (No Category) BREAKING Decrease default polling interval
• (No Category) Implement Base URL
• (No Category) Implement new string comparison logic

Miscellaneous Tasks

• (docker) BREAKING Bump lsio base image version to 3.18
• (No Category) Use constant for default retry multiplier
• (No Category) Remove unused dashboard backend endpoint
• (No Category) Ensure production mode for webpack without relying on env

Refactor

• (player) Move listen progress/range functionality into own class (SRP)
• (player state) Refactor handling of non-updated players
• (player state) Remove old play logic
• (scrobble) Print score breakdown in different statement
• (scrobble) Adjust dup score weights
• (scrobble) Refactor scrobble delay and scrobble processing sleep behavior
• (ui) Prevent nodemon from restarting on tailwind config change

Testing

• (player) Add player tests
• (scrobble) Implement basic scrobble tests
• (scrobble) Add more tests for similar-but-unique scrobble detection
• (scrobble) Add test for duplicate when exact title/time
• (scrobble) Improve test durability by using mixed duration sources
• (scrobble) Add tests for scrobble processing queue and existing comparisons