0.8.0 Configuration Normalization info

[b9AcE]

Regarding the "breaking change" of the "Configuration Normalization" in version 0.8.0 I'm just wondering, as it is written in those releasenotes ("This is a breaking change but MS will continue to operate without any changes to your config.") it could be understood as there currently being some kind of compatibility mode phase where both the old and new formats are working concurrently. Is that the case?

If so, is there somewhere we would get some info/warning regarding configuration that must be migrated before that compatibility phase ends? I could not see any such in my MS logs output and scrobbling remains fully functional as it was before re-pulling docker compose using "image: foxxmd/multi-scrobbler". Does that mean no migration is needed?

[FoxxMD]

There is no deprecation phase for the config changes and there is no way to get warnings about these changes.

However, MS will not fail to operate because a config has not been migrated, it simply will not see the old config properties anymore (until they have been moved).

I do plan to add actual config validation checks (and deprecation warnings) back in in the future but they currently do not run. The config schema is solely for viewing documentation though you can also use this site to check your config validity by copy-pasting your config into the right-hand pane.

Sorry for the confusion with my wording in the release. Below is a list of the properties that have been moved and how to migrate them. I'll mention this in the release.

To Migrate Configs

All configs already had a data property but now also have an (optional) options property at top-level.

[
  {
    "name": "Deezer",
    "data": {
        // ...
    },
    "options": {
       // ...
    }
  }
]

If this property does not exist you must create it before moving any of the listed properties. If you do not have any of the listed properties in your configs you do not need to do anything (including creating options).

For both Source and Clients

• scrobbleThresholds
• maxPollRetries
• maxRequestRetries
• retryMultiplier

Should be moved from data to options.

For Clients only

There was a data.options property like:

{
// ...
  "data": {
   // ...
   "options": { ... }
   }
}

This should be moved to be a sibling of data like:

{
// ...
  "data": {
   // ...
   },
   "options": { ... }
}

---

Additionally you can reference:

• config example
• kitchen sink example
• options schema for Sources
• options schema for Clients

to verify your config is correct.

[b9AcE]

Thank you for the ample clarification.

As there "is no deprecation phase for the config changes", would it then be correct to assume that if everything appears to remain working as as desired after the upgrade, that means these changes require no further action in such cases?

[FoxxMD]

Yes that is a fair assumption.

Part of the motivation for moving these settings to options was to differentiate between "required" or major-behavioral settings in data IE credentials, filters for not scrobbling for certain users in jellyfin, blacklisting apps in chromecast...

vs. "optional" settings or settings used for fine-tuning MS experience that don't primarily affect scrobbling/monitoring IE polling interval, number of request retries, more verbose logging for scrobble duplicate matching...

All of the settings that were migrated to options in this change are the latter.

In 95% of cases users won't have these settings listed anyways. In the remaining 5% the change may result in some un-optimal behavior IE source stopping early due to network issues that were compensated for by higher # of allowed retries. My assumption is that these users will notice and make the config changes when needed. In 0% of cases should these changes break MS, though.

[b9AcE]

Very good. I hope my questions and your answers will also benefit other users who might have had similar questions in mind. With that, I have no further questions on this and am closing the issue.