0.15.0-RC1

[FoxxMD]

Important

Release 0.14.0 contained breaking changes and deprecations that have been removed in 0.15.0. Read the Upgrade Path docs and 0.14.0 Release Notes before upgrading from Multi-Scrobbler earlier than 0.14.0!

Important

This RC contains potential breaking changes. If you have the time, please test this image and report if everything works for you! Good or bad, I need user feedback on the stability of this release.

What's New?

Apple Music Source

Thanks to the efforts of @Exerra , Apple Music is now implemented as a Source for Multi-Scrobbler!

Exerra, the primary developer of node-musickit-api, discovered that the API access required for MS to monitor listening activity only needs credentials that can be acquired from the browser of a logged in user. Critically, this bypasses the long-standing assumption that a paid apple developer account was required to access these APIs.

Exerra also contributed the entire Apple Music Source implementation to Multi-Scrobbler 👑 If you end up using this Source please consider sponsoring them as a thank you for all this hard work!

Improved Subsonic Playback Reporting

The OpenSubsonic API recently finalized a new spec for Playback Reporting that, when implemented by both the client and server, enables realtime player position reporting/states. This allows MS to track Subsonic players with the same level of accuracy as Spotfy, Jellyfin, and other first-class Sources!

Huge thanks to @JannisPohle for the initial PR on cleaning up subsonic players ( #640 ) but then stepping up to also implement this playback functionality ( #590 ) 👑

As emphasized above, this new functionality requires that both the Subsonic server and the client you use to play music from that server both implement Playback Reporting. An informational tooltip in the UI Preview will indicate if enhanced reporting is available.

Data Directories Standardization

Warning

This is a breaking change that mainly affects local (Nodejs) installations.

If you are using a Docker installation with default volume mounting (...:/config) then you are not affected.

Previously, all persistent data was stored in the directory defined by the CONFIG_DIR ENV, or defaulted to {projectDir}/config.

Now, these locations are configurable by data type and fallback to OS-standard locations:

• Configuration (config.json, jellyfin.json, etc...) uses CONFIG_DIR ENV or OS-standard locations like $XDG_CONFIG_HOME/multi-scrobbler
• Data (ms.db, logs folder, stored credentials, etc...) uses DATA_DIR ENV or OS-standard locations like $XDG_DATA_HOME/multi-scrobbler

Upgrading

If you are using a Docker installation with default volume mounting to /config then no change is required. For backwards compatibility, the docker image installation defaults both of these ENVs to /config.

For users using the nodejs/local installation, you will likely want to explicitly set both ENVs for your start command. For instance, if you are currently storing everything in the config folder within the cloned repository and the working directory is also the repository folder then add these ENVs to the beginning of your command:

CONFIG_DIR=./config DATA_DIR=./config ... npm run start

See the Config and Data Directories section in the installation docs to find the OS-standard locations MS will use when these ENVs are not set.

Monitoring Behavior

Warning

This is a potentially breaking change that affects only Icecast and Azuracast users.

In preparation for wider usage, the feature known as "Should Scrobble Behavior" has been renamed to "Monitoring Behavior". The configuration naming has been changed to reflect this.

Upgrading

If you are an Icecast or Azuracast user who has systemScrobble in your File/AIO config options, rename this property to autoMonitor. The behavior for this property remains the same.

Example

Old:

[
  {
    "name": "Station 1",
    "id": "myIceStation1",
    "data": {
      "url": "http://myIcecast.com/radio"
    },
    "options": {
      "systemScrobble": true
    }
  }
]

New:

[
  {
    "name": "Station 1",
    "id": "myIceStation1",
    "data": {
      "url": "http://myIcecast.com/radio"
    },
    "options": {
      "autoMonitor": true
    }
  }
]

Config Improvements

Warning

Contains a breaking change that potentially affects User Stage Transforms and removes deprecated caching configuration from pre 0.14.0.

Internally, config has undergone a complete overhaul and is now entirely built using Zod. This is a huge improvement over the hacky typescript-types-to-json-schema generator that was being used because the config shape now fully dictates validation, rather than there being a reflection middle step. It additionally removes the ajv library and saves almost 30MB in the docker image when uncompressed.

With the overhaul, a simplification of the config reduced development complexity and made the config explorer in docs clearer, at the expensive of a few, potential breaking changes.

Upgrading

User Stage Transforms

If you have User Stage transforms and they do not already have a "type": "user" property, you need to now add this property or validation will throw an error.

Example

Previous User Transform config could be untyped like

    "options": {
      "playTransform": {
        "preCompare": [
            {
                "title": [
                    "badTerm",
                ]
            }
        ],
      }

Now, all user transforms must be typed like all other transforms or config parsing will throw an error:

    "options": {
      "playTransform": {
        "preCompare": [
            {
                "type": "user",
                "title": [
                    "badTerm",
                ]
            }
        ],
      }

Removed Deprecated Cache Config

Cache Configuration was simplified in 0.14.0 but using pre-0.14.0 configuration only caused a deprecation warning. Now, these deprecations have been removed and using the old configuration will cause an error.

Node Native Runtime

Multi-Scrobbler has been refactored to remove the dependency on tsx as the runtime. Now, MS uses Nodejs' type stripping so that it can directly run the source typescript files without needing the typescript runtime or any compilation steps.

This reduces packaging, tooling, and local run complexity:

• environments do not need to rely on npm scripts for running MS
  • or needing to specify the tsx binary with node for commands
• Improves process monitoring readability
• Reduces memory usage since typescript does not need to be loaded into memory
• Reduces disk space since typescript does not need to be installed to run in production
• Tooling calls (mocha, vscode extensions) can directly use node without a shim

If you are currently running MS without using npm run start and have questions about how to migrate please open a discussion.

UI Preview Improvements

The New UI Preview introduced in 0.14.2 has seen several rounds of refinement thanks to user feedback. It is still in "read-only" mode for this release but the next release will begin to introduce write functionality. Check out the preview on your instance:

http://yourMsDomain/next

and share your feedback in the github issue!

Other Changelog Highlights

🐛 Bug Fixes

• (client) Correct create/update timestamps for queues and scrobbles
• (client) Correct SOT scrobble api requests to not have the same from/to value
• (listenbrainz) Fix play fetch more indicator
• (musicbrainz) Catch scenario where all search prereqs fail
• (rocksky) Fix missing albumArtist field bug: Rocksky Authentication Issue after Latest Update 0.14.2 #632
• (ui) Stabilize play timeline item order
• (mpd) Assign empty array if artists not defined bug: MPD Radio Stream Error #621
• (No Category) Fix play fetch options logging data for pageless functions

🧪 Testing

• (No Category) Fix db error test using transient db

[Exerra]

I've been on the edge image this entire time and now on the RC image. My basic use of Apple Music -> Last.fm works well. New UI also works well.

Yolo, release now and pray

[FoxxMD]

Thanks for testing it! The test suite, typescript in general, and the large number of newly introduced eslint rules are giving me good confidence these days but with this diff from 0.14.2 -> 0.15.0

403 changed files with 15,421 additions and 9,872 deletions.

I want to be extra sure with this one 😅

[FoxxMD]

@FestiveByteRider if you still wanted to configure MS using komodo Config Files as discussed in #573 you can now do this using the separate config/data directories in 0.15.0-RC1 :

services:
    multi-scrobbler:
      # ...
    environment:
      - DATA_DIR=/mydata
      - CONFIG_DIR/config
      # ...
    volumes:
        - ./myConfigs:/config
        - /host/dir/to/data:/mydata

You'd then add ./myConfigs/config.json as a komodo Config File in the MS stack. /host/dir/to/data still needs to be a persistent directory outside of the repository (on the host machine) so that it survives a container re-deployment and repo re-clone.

You would also need to move all the files to the correct folder:

• config.json and all specific source/client config files like lastfm.json ... into ./myConfigs in the repository
• everything else -- ms.db, any credentials file (has currentCreds in name), cache files (has .cache in name), logs folder -- into /host/dir/to/data