docs(deezer): Deprecate due to discontinued API support

Deprecate Source with warning message and update docs. #175
FoxxMD · Aug 19, 2024 · 831cefd · 831cefd
1 parent 114a3dd
commit 831cefd
Show file tree

Hide file tree

Showing 6 changed files with 24 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -20,7 +20,7 @@ A javascript app to scrobble music you listened to, to [Maloja](https://github.c
   * [Youtube Music](https://foxxmd.github.io/multi-scrobbler/docs/configuration#youtube-music)
   * [Last.fm](https://foxxmd.github.io/multi-scrobbler/docs/configuration#lastfm-source)
   * [ListenBrainz](https://foxxmd.github.io/multi-scrobbler/docs/configuration#listenbrainz-source)
-  * [Deezer](https://foxxmd.github.io/multi-scrobbler/docs/configuration#deezer)
+  * [~~Deezer~~](https://foxxmd.github.io/multi-scrobbler/docs/configuration#deezer)
   * [MPRIS (Linux Desktop)](https://foxxmd.github.io/multi-scrobbler/docs/configuration#mpris)
   * [Mopidy](https://foxxmd.github.io/multi-scrobbler/docs/configuration#mopidy)
   * [JRiver](https://foxxmd.github.io/multi-scrobbler/docs/configuration#jriver)

diff --git a/docsite/docs/FAQ.md b/docsite/docs/FAQ.md
@@ -124,6 +124,10 @@ If multi-scrobbler is not running on the same machine your browser is on then th
 
 EX `http://localhost:9078/lastfm/callback` -> `http://192.168.0.220:9078/lastfm/callback`
 
+### Deezer is not working
+
+Deezer has discontinued support for their API and the Deezer Source is now [**deprecated.**](configuration/configuration.mdx#deezer) See [this issue for more discussion.](https://github.com/FoxxMD/multi-scrobbler/issues/175#issuecomment-2296776625)
+
 ## Configuration Issues
 
 ### Config could not be parsed

diff --git a/docsite/docs/configuration/configuration.mdx b/docsite/docs/configuration/configuration.mdx
@@ -147,7 +147,7 @@ These options affect multi-scrobbler's behavior and are not specific to any sour
 
 #### Base URL
 
-Defines the URL that is used to generate default redirect URLs for authentication on [spotify](#spotify), [lastfm](#lastfm), and [deezer](#deezer) -- as well as some logging hints.
+Defines the URL that is used to generate default redirect URLs for authentication on [spotify](#spotify) and [lastfm](#lastfm) -- as well as some logging hints.
 
 * Default => `http://localhost:9078`
 * Set with [ENV](./configuration?configType=env#configuration-types) `BASE_URL` or `baseUrl` [all-in-one configuration](./configuration?configType=aio#configuration-types)
@@ -492,7 +492,21 @@ On your [profile page](https://listenbrainz.org/profile/) find your **User Token
     </TabItem>
 </Tabs>
 
-### [Deezer](https://deezer.com/)
+### [~~Deezer~~](https://deezer.com/)
+
+:::warning
+
+**This Source is DEPRECATED because Deezer has dropped official API support.** This Source will **not** be removed but no further support or fixes will be given.
+
+Users cannot create new applications on Deezer Developers and there is no guarantee existing applications will continue to work.
+
+As a workaround consider integrating Deezer with last.fm and then using [last.fm as a Source](#lastfm-source).
+
+Users with existing Deezer applications in use with multi-scrobbler should consider this change as well to avoid future breaking issues with the unsupported API.
+
+[See this issue for more discussion.](https://github.com/FoxxMD/multi-scrobbler/issues/175#issuecomment-2296776625)
+
+:::
 
 Create a new application at [Deezer Developers](https://developers.deezer.com/myapps)
 

diff --git a/docsite/src/pages/index.mdx b/docsite/src/pages/index.mdx
@@ -21,7 +21,7 @@ A javascript app to scrobble music you listened to, to [Maloja](https://github.c
     * [Youtube Music](docs/configuration#youtube-music)
     * [Last.fm](docs/configuration#lastfm-source)
     * [ListenBrainz](docs/configuration#listenbrainz-source)
-    * [Deezer](docs/configuration#deezer)
+    * [~~Deezer~~](docs/configuration#deezer)
     * [MPRIS (Linux Desktop)](docs/configuration#mpris)
     * [Mopidy](docs/configuration#mopidy)
     * [JRiver](docs/configuration#jriver)

diff --git a/flatpak/io.github.foxxmd.multiscrobbler.metainfo.xml b/flatpak/io.github.foxxmd.multiscrobbler.metainfo.xml
@@ -26,7 +26,6 @@
             <li>Jellyfin</li>
             <li>WebScrobbler</li>
             <li>Mopidy</li>
-            <li>Deezer</li>
             <li>JRiver</li>
             <li>Kodi</li>
             <li>Webscrobbler</li>

diff --git a/src/backend/sources/DeezerSource.ts b/src/backend/sources/DeezerSource.ts
@@ -90,6 +90,8 @@ export default class DeezerSource extends AbstractSource {
     }
 
     protected async doBuildInitData(): Promise<true | string | undefined> {
+        this.logger.warn('This Source is DEPRECATED! Deezer has dropped support official API support. New apps cannot be created and existing apps are not guaranteed to continue working. See the documentation or this issue for more information: https://github.com/FoxxMD/multi-scrobbler/issues/175#issuecomment-2296776625');
+
         try {
             const credFile = await readJson(this.workingCredsPath, {throwOnNotFound: false});
             if(credFile !== undefined) {