feat(listenbrainz): Implement Now Playing functionality

Author: FoxxMD

docsite/docs/configuration/configuration.mdx

@@ -2439,6 +2439,7 @@ Clients can customize the Now Playing behavior individually using [File or AIO s
         //"nowPlaying": true
         //
         // OR define a list of Source *config* names that should be allowed to report Now Playing
+        // order of the list determines priority for reporting Now Playing
         //"nowPlaying": ["mySpotify1","myJellyfin2"]
     }
   },
@@ -2448,7 +2449,7 @@ Clients can customize the Now Playing behavior individually using [File or AIO s
 ### Supported Scrobble Clients
 
 * [Last.fm](#lastfm)
-* More coming soon
+* [Listenbrainz](#listenbrainz)
 
 ## Monitoring
 

src/backend/common/vendor/ListenbrainzApiClient.ts

@@ -20,6 +20,7 @@ import { getBaseFromUrl, isPortReachableConnect, joinedUrl, normalizeWebAddress
 import { parseRegexSingleOrFail } from '../../utils.js';
 import {ListensResponse as KoitoListensResponse} from '../infrastructure/config/client/koito.js'
 import { listenObjectResponseToPlay } from './koito/KoitoApiClient.js';
+import { log } from 'console';
 
 
 export interface ArtistMBIDMapping {
@@ -97,11 +98,18 @@ export interface ListenPayload {
     track_metadata: TrackPayload;
 }
 
+export type ListenType = 'single' | 'playing_now';
+
 export interface SubmitPayload {
-    listen_type: 'single' | 'playing_now',
+    listen_type: ListenType,
     payload: [ListenPayload]
 }
 
+interface SubmitOptions {
+    log?: boolean
+    listenType?: ListenType
+}
+
 export interface TrackResponse extends MinimumTrack {
     duration: number
     additional_info: AdditionalTrackInfoResponse
@@ -320,9 +328,13 @@ export class ListenbrainzApiClient extends AbstractApiClient {
     }
 
 
-    submitListen = async (play: PlayObject, log: boolean = false) => {
+    submitListen = async (play: PlayObject, options: SubmitOptions = {}) => {
+        const { log = false, listenType = 'single'} = options;
         try {
-            const listenPayload: SubmitPayload = {listen_type: 'single', payload: [ListenbrainzApiClient.playToListenPayload(play)]};
+            const listenPayload: SubmitPayload = {listen_type: listenType, payload: [ListenbrainzApiClient.playToListenPayload(play)]};
+            if(listenType === 'playing_now') {
+                delete listenPayload.payload[0].listened_at;
+            }
             if(log) {
                 this.logger.debug(`Submit Payload: ${JSON.stringify(listenPayload)}`);
             }

src/backend/scrobblers/LastfmScrobbler.ts

@@ -189,7 +189,7 @@ export default class LastfmScrobbler extends AbstractScrobbleClient {
             return response;
         } catch (e) {
             if (!(e instanceof UpstreamError)) {
-                throw new UpstreamError('Error received from LastFM API', {cause: e, showStopper: true});
+                throw new UpstreamError('Error received from LastFM API', {cause: e, showStopper: false});
             } else {
                 throw e;
             }

src/backend/scrobblers/ListenbrainzScrobbler.ts

@@ -11,6 +11,7 @@ import { ListenbrainzApiClient, ListenPayload } from "../common/vendor/Listenbra
 import { Notifiers } from "../notifier/Notifiers.js";
 
 import AbstractScrobbleClient from "./AbstractScrobbleClient.js";
+import { isDebugMode } from "../utils.js";
 
 export default class ListenbrainzScrobbler extends AbstractScrobbleClient {
 
@@ -27,6 +28,7 @@ export default class ListenbrainzScrobbler extends AbstractScrobbleClient {
         // https://listenbrainz.readthedocs.io/en/latest/users/api/core.html#get--1-user-(user_name)-listens
         // 1000 is way too high. maxing at 100
         this.MAX_INITIAL_SCROBBLES_FETCH = 100;
+        this.supportsNowPlaying = true;
     }
 
     formatPlayObj = (obj: any, options: FormatPlayObjectOptions = {}) => ListenbrainzApiClient.formatPlayObj(obj, options);
@@ -80,7 +82,7 @@ export default class ListenbrainzScrobbler extends AbstractScrobbleClient {
         } = playObj;
 
         try {
-            await this.api.submitListen(playObj, true);
+            await this.api.submitListen(playObj, { log: isDebugMode()});
 
             if (newFromSource) {
                 this.logger.info(`Scrobbled (New)     => (${source}) ${buildTrackString(playObj)}`);
@@ -93,4 +95,14 @@ export default class ListenbrainzScrobbler extends AbstractScrobbleClient {
             throw new UpstreamError(`Error occurred while making Listenbrainz API scrobble request: ${e.message}`, {cause: e, showStopper: !(e instanceof UpstreamError)});
         }
     }
+
+    doPlayingNow = async (data: PlayObject) => {
+        if(!this.isKoito) {
+            try {
+                await this.api.submitListen(data, { listenType: 'playing_now'});
+            } catch (e) {
+                throw new UpstreamError(`Error occurred while making Listenbrainz API Playing Now request: ${e.message}`, {cause: e, showStopper: !(e instanceof UpstreamError)});
+            }
+        }
+    }
 }