Merge branch 'develop'

Author: FoxxMD

config/listenbrainz.json.example

@@ -1,7 +1,7 @@
 [
   {
     "name": "brainz",
-    "configureAs": "client"
+    "configureAs": "client",
     "data": {
       "token": "029b081ba-9156-4pe7-88e5-3be671f5ea2b",
       "username": "FoxxMD"

flatpak/README.md

@@ -1,6 +1,6 @@
 NOTE: This steps are for building the flatpak entirely locally, from source. If you want to install the application normally then [get it through flathub](/docs/installation.md#flatpak)
 
-Flatpak build is a little convoluted until someone sets me straight...
+The final build repo for the flathub version can be found at [flathub/io.github.foxxmd.multiscrobbler](https://github.com/flathub/io.github.foxxmd.multiscrobbler)
 
 # 1. Install Requirements
 

flatpak/io.github.foxxmd.multiscrobbler.metainfo.xml

@@ -41,6 +41,7 @@
         </screenshot>
     </screenshots>
     <releases>
+        <release version="0.4.6" date="2023-06-07"/>
         <release version="0.4.4" date="2023-03-20"/>
     </releases>
     <categories>

flatpak/io.github.foxxmd.multiscrobbler.yml

@@ -55,7 +55,8 @@ modules:
     sources:
       - type: git
         url: https://github.com/FoxxMD/multi-scrobbler
-        commit: 9a578e54a89f87c82ff811bb04257c9b641b199a
+        tag: 0.4.6
+        commit: 5e905eae1798482dbcef504500d26a028c2e15cb
         dest: main
       # Wrapper to launch the app
       - type: script

package.json

@@ -1,6 +1,6 @@
 {
   "name": "multi-scrobbler",
-  "version": "0.4.0",
+  "version": "0.4.6",
   "description": "scrobble plays from multiple sources to multiple clients",
   "main": "src/index.js",
   "scripts": {

src/apis/KodiApiClient.ts

@@ -53,7 +53,7 @@ export class KodiApiClient extends AbstractApiClient {
         const {
             url = 'http://localhost:8080/jsonrpc'
         } = config;
-        this.url = KodiApiClient.parseConnectionUrl('http://localhost:8080');
+        this.url = KodiApiClient.parseConnectionUrl(url);
         const auth = new Buffer(`${config.username}:${config.password}`).toString('base64');
         this.client = new KodiClient({
             clientType: this.url.protocol.replace(':', '') as ('http' | 'https'),

src/apis/maloja/interfaces.ts

@@ -0,0 +1,82 @@
+export interface MalojaV2ScrobbleData {
+    artists: string[]
+    title: string
+    album: string
+    /**
+     * Length of the track
+     * */
+    duration: number
+    /**
+     * unix timestamp (seconds) scrobble was made at
+     * */
+    time: number
+}
+
+export interface MalojaAlbumData {
+    name?: string
+    albumtitle?: string
+    artists: string[]
+}
+
+export interface MalojaV3ScrobbleData {
+    /**
+     * unix timestamp (seconds) scrobble was made at
+     * */
+    time: number
+    track: {
+        artists: string[]
+        title: string
+        album?: MalojaAlbumData | null
+        /**
+         * length of the track
+         * */
+        length: number
+    }
+    /**
+     * how long the track was listened to before it was scrobbled
+     * */
+    duration: number
+}
+
+export type MalojaScrobbleData = MalojaV2ScrobbleData | MalojaV3ScrobbleData;
+
+export interface MalojaScrobbleRequestData {
+    key: string
+    title: string
+    album: string
+    time: number
+    length: number
+}
+
+export interface MalojaScrobbleV2RequestData extends MalojaScrobbleRequestData {
+    artist: string
+}
+
+export interface MalojaScrobbleV3RequestData extends MalojaScrobbleRequestData {
+    artists: string[]
+}
+
+interface MalojaScrobbleWarning {
+    type: string
+    value: string[] | string
+    desc: string
+}
+
+export interface MalojaResponseV3CommonData {
+    status: 'failure' | 'error' | 'success' | 'ok'
+    error?: {
+        type: string
+        value?: string | object
+        desc: string
+    }
+}
+
+export interface MalojaScrobbleV3ResponseData extends MalojaResponseV3CommonData {
+    track?: {
+        title: string
+        artists: string[]
+        album?: MalojaAlbumData | null
+    }
+    desc: string
+    warnings?: MalojaScrobbleWarning[]
+}

src/clients/MalojaScrobbler.ts

@@ -14,18 +14,18 @@ import {
 import {
     FormatPlayObjectOptions,
     INITIALIZING,
-    MalojaScrobbleData,
-    MalojaScrobbleRequestData,
-    MalojaScrobbleV2RequestData,
-    MalojaScrobbleV3RequestData,
-    MalojaV2ScrobbleData,
-    MalojaV3ScrobbleData,
     PlayObject,
     TrackStringOptions
 } from "../common/infrastructure/Atomic.js";
 import {MalojaClientConfig} from "../common/infrastructure/config/client/maloja.js";
 import {Notifiers} from "../notifier/Notifiers.js";
 import {Logger} from '@foxxmd/winston';
+import {
+    MalojaScrobbleData,
+    MalojaScrobbleRequestData,
+    MalojaScrobbleV2RequestData,
+    MalojaScrobbleV3RequestData, MalojaScrobbleV3ResponseData, MalojaV2ScrobbleData, MalojaV3ScrobbleData
+} from "../apis/maloja/interfaces";
 
 const feat = ["ft.", "ft", "feat.", "feat", "featuring", "Ft.", "Ft", "Feat.", "Feat", "Featuring"];
 
@@ -65,10 +65,7 @@ export default class MalojaScrobbler extends AbstractScrobbleClient {
                 track: {
                     artists: mArtists,
                     title: mTitle,
-                    album: {
-                        name: mAlbum,
-                        artists: albumArtists
-                    } = {},
+                    album: mAlbum,
                     // length of the track
                     length: mLength,
                 } = {},
@@ -79,7 +76,14 @@ export default class MalojaScrobbler extends AbstractScrobbleClient {
             time = mTime;
             title = mTitle;
             duration = mLength;
-            album = mAlbum;
+            if(mAlbum !== null) {
+                const {
+                    albumtitle,
+                    name: mAlbumName,
+                    artists: albumArtists
+                } = mAlbum || {};
+                album = albumtitle ?? mAlbumName;
+            }
         } else {
             // scrobble data structure for v2 and below
             const {
@@ -384,6 +388,8 @@ export default class MalojaScrobbler extends AbstractScrobbleClient {
             length: duration,
         };
 
+        let responseBody: MalojaScrobbleV3ResponseData;
+
         try {
             // 3.0.3 has a BC for something (maybe seconds => length ?) -- see #42 in repo
             if(this.serverVersion === undefined || compareVersions(this.serverVersion, '3.0.2') > 0) {
@@ -398,53 +404,77 @@ export default class MalojaScrobbler extends AbstractScrobbleClient {
                 .type('json')
                 .send(scrobbleData));
 
-            let scrobbleResponse = {};
+            let scrobbleResponse: any | undefined = undefined,
+                scrobbledPlay: PlayObject;
 
             if(this.serverVersion === undefined || compareVersions(this.serverVersion, '3.0.0') >= 0) {
+                responseBody = response.body;
                 const {
-                    body: {
-                    // @ts-expect-error TS(2525): Initializer provides no value for this binding ele... Remove this comment to see the full error message
                     track,
-                } = {}
-                } = response;
-                scrobbleResponse = {
-                    time: playDate.unix(),
-                    track: {
-                        ...track,
-                        length: duration
-                    },
-                }
-                if(album !== undefined) {
-                    const {
-                        album: malojaAlbum = {},
-                    } = track;
-                    // @ts-expect-error TS(2339): Property 'track' does not exist on type '{}'.
-                    scrobbleResponse.track.album = {
-                        ...malojaAlbum,
-                        name: album
+                    status,
+                    warnings = [],
+                } = responseBody;
+                if(status === 'success') {
+                    if(track !== undefined) {
+                        scrobbleResponse = {
+                            time: playDate.unix(),
+                            track: {
+                                ...track,
+                                length: duration
+                            },
+                        }
+                        if (album !== undefined) {
+                            const {
+                                album: malojaAlbum = {},
+                            } = track;
+                            scrobbleResponse.track.album = {
+                                ...malojaAlbum,
+                                name: album
+                            }
+                        }
                     }
+                    if(warnings.length > 0) {
+                        for(const w of warnings) {
+                            this.logger.warn(`Maloja Warning: ${w.desc} => ${JSON.stringify(w.value)}`)
+                        }
+                    }
+                } else {
+                    throw new Error(buildErrorString(response));
                 }
             } else {
-                const {body: {
-                    // @ts-expect-error TS(2525): Initializer provides no value for this binding ele... Remove this comment to see the full error message
-                    track: {
-                        time: mTime = playDate.unix(),
-                        duration: mDuration = duration,
-                        album: mAlbum = album,
-                        ...rest
-                    }
-                } = {}} = response;
+                const {
+                    body: {
+                        track: {
+                            time: mTime = playDate.unix(),
+                            duration: mDuration = duration,
+                            album: mAlbum = album,
+                            ...rest
+                        } = {}
+                    } = {}
+                } = response;
                 scrobbleResponse = {...rest, album: mAlbum, time: mTime, duration: mDuration};
             }
-            this.addScrobbledTrack(playObj, this.formatPlayObj(scrobbleResponse));
-            if (newFromSource) {
-                this.logger.info(`Scrobbled (New)     => (${source}) ${buildTrackString(playObj)}`);
+            let warning = '';
+            if(scrobbleResponse === undefined) {
+                warning = `WARNING: Maloja did not return track data in scrobble response! Maybe it didn't scrobble correctly??`;
+                scrobbledPlay = playObj;
+            } else {
+                scrobbledPlay = this.formatPlayObj(scrobbleResponse)
+            }
+            this.addScrobbledTrack(playObj, scrobbledPlay);
+            const scrobbleInfo = `Scrobbled (${newFromSource ? 'New' : 'Backlog'})     => (${source}) ${buildTrackString(playObj)}`;
+            if(warning !== '') {
+                this.logger.warn(`${scrobbleInfo} | ${warning}`);
+                this.logger.debug(`Response: ${this.logger.debug(JSON.stringify(response.body))}`);
             } else {
-                this.logger.info(`Scrobbled (Backlog) => (${source}) ${buildTrackString(playObj)}`);
+                this.logger.info(scrobbleInfo);
             }
         } catch (e) {
             await this.notifier.notify({title: `Client - ${capitalize(this.type)} - ${this.name} - Scrobble Error`, message: `Failed to scrobble => ${buildTrackString(playObj)} | Error: ${e.message}`, priority: 'error'});
             this.logger.error(`Scrobble Error (${sType})`, {playInfo: buildTrackString(playObj), payload: scrobbleData});
+            if(responseBody !== undefined) {
+                this.logger.error('Raw Response:', responseBody);
+            }
             throw e;
         } finally {
             this.logger.debug('Raw Payload:', scrobbleData);
@@ -453,3 +483,30 @@ export default class MalojaScrobbler extends AbstractScrobbleClient {
         return true;
     }
 }
+
+const buildErrorString = (body: MalojaScrobbleV3ResponseData) => {
+    let valString: string | undefined = undefined;
+    const {
+        status,
+        error: {
+            type,
+            value,
+            desc
+        } = {}
+    } = body;
+    if(value !== undefined && value !== null) {
+        if(typeof value === 'string') {
+            valString = value;
+        } else if(Array.isArray(value)) {
+            valString = value.map(x => {
+                if(typeof x === 'string') {
+                    return x;
+                }
+                return JSON.stringify(x);
+            }).join(', ');
+        } else {
+            valString = JSON.stringify(value);
+        }
+    }
+    return `Maloja API returned ${status} of type ${type} "${desc}"${valString !== undefined ? `: ${valString}` : ''}`;
+}

src/common/infrastructure/Atomic.ts

@@ -134,60 +134,6 @@ export interface ScrobbledPlayObject {
     scrobble: PlayObject
 }
 
-export interface MalojaV2ScrobbleData {
-    artists: string[]
-    title: string
-    album: string
-    /**
-     * Length of the track
-     * */
-    duration: number
-    /**
-     * unix timestamp (seconds) scrobble was made at
-     * */
-    time: number
-}
-
-export interface MalojaV3ScrobbleData {
-    /**
-     * unix timestamp (seconds) scrobble was made at
-     * */
-    time: number
-    track: {
-        artists: string[]
-        title: string
-        album?: {
-            name: string
-            artists: string[]
-        }
-        /**
-         * length of the track
-         * */
-        length: number
-    }
-    /**
-     * how long the track was listened to before it was scrobbled
-     * */
-    duration: number
-}
-
-export type MalojaScrobbleData = MalojaV2ScrobbleData | MalojaV3ScrobbleData;
-
-export interface MalojaScrobbleRequestData {
-    key: string
-    title: string
-    album: string
-    time: number
-    length: number
-}
-
-export interface MalojaScrobbleV2RequestData extends MalojaScrobbleRequestData {
-    artist: string
-}
-
-export interface MalojaScrobbleV3RequestData extends MalojaScrobbleRequestData {
-    artists: string[]
-}
 
 export interface RemoteIdentityParts {
     host: string,