Merge pull request #312 from FoxxMD/lzEnrich

feat: Enrich Listenbrainz submit payload

Author: FoxxMD

.vscode/launch.json

@@ -16,6 +16,25 @@
                 "${workspaceFolder}/node_modules/**",
             ],
         },
+        {
+            "name": "dev (ENV Only)",
+            "type": "node",
+            "request": "launch",
+            // Debug app in VSCode
+            "program": "${workspaceFolder}/src/backend/index.ts",
+            "runtimeExecutable": "${workspaceFolder}/node_modules/.bin/tsx",
+            "console": "integratedTerminal",
+            "envFile": "${workspaceFolder}/.env",
+            "env": {
+                "CONFIG_DIR": "./not-real"
+            },
+            "internalConsoleOptions": "neverOpen",
+            "skipFiles": [
+                "<node_internals>/**",
+                // Ignore all dependencies (optional)
+                "${workspaceFolder}/node_modules/**",
+            ],
+        },
         {
             "name": "tsx",
             "type": "node",

src/backend/common/vendor/ListenbrainzApiClient.ts

@@ -74,8 +74,21 @@ export interface AdditionalTrackInfoResponse extends AdditionalTrackInfo {
     recording_msid?: string
 }
 
+// using submit-listens example from openapi https://rain0r.github.io/listenbrainz-openapi/index.html#/lbCore/submitListens
+// which is documented in official docs https://listenbrainz.readthedocs.io/en/latest/users/api/index.html#openapi-specification
+// and based on this LZ developer comment https://github.com/lyarenei/jellyfin-plugin-listenbrainz/issues/10#issuecomment-1253867941
+export interface SubmitListenAdditionalTrackInfo extends AdditionalTrackInfo {
+    artist_names?: string[]
+    release_artist_name?: string
+    release_artist_names?: string[]
+    spotify_album_id?: string
+    spotify_album_artist_ids?: string[]
+    spotify_artist_ids?: string[]
+    albumartist?: string
+}
+
 export interface TrackPayload extends MinimumTrack {
-    additional_info?: AdditionalTrackInfo
+    additional_info?: SubmitListenAdditionalTrackInfo
 }
 
 export interface ListenPayload {
@@ -339,22 +352,49 @@ export class ListenbrainzApiClient extends AbstractApiClient {
                 track,
                 duration,
                 meta: {
-                    brainz = {}
+                    brainz = {},
+                    spotify = {}
                 } = {}
             }
         } = play;
+        // using submit-listens exmaple from openapi https://rain0r.github.io/listenbrainz-openapi/index.html#/lbCore/submitListens
+        // which is documented in official docs https://listenbrainz.readthedocs.io/en/latest/users/api/index.html#openapi-specification
+        // and based on this LZ developer comment https://github.com/lyarenei/jellyfin-plugin-listenbrainz/issues/10#issuecomment-1253867941
+
+        const addInfo: SubmitListenAdditionalTrackInfo = {
+            // all artists
+            artist_names: Array.from(new Set([...artists, ...albumArtists])),
+            // primary artist
+            release_artist_name: artists[0],
+            release_artist_names: [artists[0]],
+        };
+
+        if(spotify.track !== undefined) {
+            addInfo.spotify_id = spotify.track;
+        }
+        if(spotify.album !== undefined) {
+            addInfo.spotify_album_id = spotify.album;
+        }
+        if(spotify.albumArtist !== undefined && spotify.albumArtist.length > 0) {
+            addInfo.spotify_album_artist_ids = spotify.albumArtist;
+        }
+        if(spotify.artist !== undefined) {
+            addInfo.spotify_artist_ids = spotify.artist;
+        }
+
         return {
             listened_at: getScrobbleTsSOCDate(play).unix(),
             track_metadata: {
-                artist_name: artists[0],
+                artist_name: Array.from(new Set([...artists, ...albumArtists])).join(', '),
                 track_name: track,
                 release_name: album,
                 additional_info: {
                     duration: play.data.duration !== undefined ? Math.round(duration) : undefined,
                     track_mbid: brainz.track,
                     artist_mbids: brainz.artist,
                     release_mbid: brainz.album,
-                    release_group_mbid: brainz.releaseGroup
+                    release_group_mbid: brainz.releaseGroup,
+                    ...addInfo
                 }
             }
         }

src/backend/sources/SpotifySource.ts

@@ -2,7 +2,7 @@ import dayjs, { Dayjs } from "dayjs";
 import EventEmitter from "events";
 import SpotifyWebApi from "spotify-web-api-node";
 import request from 'superagent';
-import { PlayObject, SCROBBLE_TS_SOC_END, SCROBBLE_TS_SOC_START, ScrobbleTsSOC } from "../../core/Atomic.js";
+import { PlayObject, SCROBBLE_TS_SOC_END, SCROBBLE_TS_SOC_START, ScrobbleTsSOC, SpotifyMeta } from "../../core/Atomic.js";
 import { combinePartsToString, truncateStringToLength } from "../../core/StringUtils.js";
 import { isNodeNetworkException } from "../common/errors/NodeErrors.js";
 import { hasUpstreamError, UpstreamError } from "../common/errors/UpstreamError.js";
@@ -155,6 +155,7 @@ export default class SpotifySource extends MemoryPositionalSource {
         }
 
         const {
+            id: albumId,
             name: albumName,
             artists: albumArtists = [],
             images = []
@@ -183,7 +184,15 @@ export default class SpotifySource extends MemoryPositionalSource {
                 track: name,
                 duration: duration_ms / 1000,
                 playDate: played_at,
-                playDateCompleted
+                playDateCompleted,
+                meta: {
+                    spotify: {
+                        track: id,
+                        artist: artists.map(x => x.id),
+                        albumArtist: actualAlbumArtists.map(x => x.id),
+                        album: albumId
+                    }
+                }
             },
             meta: {
                 deviceId: deviceId ?? `${NO_DEVICE}-${NO_USER}`,

src/core/Atomic.ts

@@ -74,6 +74,13 @@ export interface BrainzMeta {
     releaseGroup?: string
 }
 
+export interface SpotifyMeta {
+    artist?: string[]
+    albumArtist?: string[]
+    album?: string
+    track?: string
+}
+
 export interface TrackData {
     artists?: string[]
     albumArtists?: string[]
@@ -86,6 +93,7 @@ export interface TrackData {
 
     meta?: {
         brainz?: BrainzMeta
+        spotify?: SpotifyMeta
     }
 }