feat: show crown on ln commands, revamp graph engine

lyricalsoul · lyricalsoul · commit fb611bc3bb45 · 2025-02-25T22:21:04.000-04:00
diff --git a/.idea/sqldialects.xml b/.idea/sqldialects.xml
diff --git a/assets/locales/en/commands.json b/assets/locales/en/commands.json
@@ -37,20 +37,20 @@
     "$t(commands:common.lnTitle, {\"name\": \"{{user}}\", \"context\": \"{{isListening}}\"})",
     "{{emoji}} **{{track}}**",
     "💽 {{album}}",
-    "🧑‍🎤 {{artist}}",
+    "{{artistCrown}} {{artist}}",
     "$t(commands:common.scrobbles, {\"count\": {{playCount}}})",
     "{{-tags}}"
   ],
   "album": [
     "$t(commands:common.lnTitle, {\"name\": \"{{user}}\", \"context\": \"{{isListening}}\"})",
     "💽 **{{album}}**",
-    "🧑‍🎤 {{artist}}",
+    "{{artistCrown}} {{artist}}",
     "$t(commands:common.scrobbles, {\"count\": {{playCount}}})",
     "{{-tags}}"
   ],
   "artist": [
     "$t(commands:common.lnTitle, {\"name\": \"{{user}}\", \"context\": \"{{isListening}}\"})",
-    "🧑‍🎤 **{{artist}}**",
+    "{{artistCrown}} **{{artist}}**",
     "$t(commands:common.scrobbles, {\"count\": {{playCount}}})",
     "{{-tags}}"
   ],
@@ -154,16 +154,14 @@
     "noScrobbles": "🤔 You didn't give me an artist name nor are you listening to anything right now. What do you want me to check?"
   },
   "meartist": [
-    "$t(commands:common.lnTitle, {\"name\": \"{{user}}\", \"context\": \"{{isListening}}\"})",
+    "$t(commands:common.lnOther, {\"name\": \"{{user}}\", \"count\": {{playCount}}})",
     "🧑‍🎤 **{{artist}}**",
-    "$t(commands:common.scrobbles, {\"count\": {{playCount}}})",
     "{{-tags}}"
   ],
   "mealbum": [
-    "$t(commands:common.lnTitle, {\"name\": \"{{user}}\", \"context\": \"{{isListening}}\"})",
+    "$t(commands:common.lnOther, {\"name\": \"{{user}}\", \"count\": {{playCount}}})",
     "💽 **{{album}}**",
     "🧑‍🎤 {{artist}}",
-    "$t(commands:common.scrobbles, {\"count\": {{playCount}}})",
     "{{-tags}}"
   ],
   "unlinkfm": {
diff --git a/src/commandEngine/commands/noDMs+registered/crowns.ts b/src/commandEngine/commands/noDMs+registered/crowns.ts
@@ -1,16 +1,12 @@
 import { Context } from '../../../multiplatformEngine/common/context.js'
-import { graphEngine } from '../../../graphEngine/index.js'
-
-type Args = {
-  artistName: string
-}
-type InternalArtistType = { name: string, mbid: string | undefined, imageURL: string | undefined, playCount: number }
+import { getUserCrowns } from '../../../graphEngine/operations/crowns.js'
+import { getArtistDataByMbid } from '../../../graphEngine/operations.js'
 
 export default async (ctx: Context) => {
   const username = ctx.targetedUserData?.fmUsername ?? ctx.registeredUserData!.fmUsername
   const displayName = ctx.targetedUser?.name ?? ctx.registeredUser!.name
 
-  const crowns = await graphEngine.getUserCrowns(ctx.channel.id, username).then((r) => {
+  const crowns = await getUserCrowns(ctx.channel.id, username).then((r) => {
     if (!r?.length) return undefined
     return r.sort((a: any, b: any) => b.createdat - a.createdat)
   })
@@ -21,7 +17,7 @@ export default async (ctx: Context) => {
   }
 
   // sort by createdAt
-  const artistNames = await Promise.all(crowns.map((c: any) => graphEngine.getArtistNameByMbid(c.artistmbid)))
+  const artistNames = await Promise.all(crowns.map((c: any) => getArtistDataByMbid(c.artistmbid).then(a => a.name)))
   let crownsText = ''
   for (let i = 0; i < crownCount; i++) {
     const crown = crowns[i]
diff --git a/src/commandEngine/commands/noDMs+registered/whoknowsartist.ts b/src/commandEngine/commands/noDMs+registered/whoknowsartist.ts
@@ -1,9 +1,9 @@
 import { Context } from '../../../multiplatformEngine/common/context.js'
-import { fixLanguageFormat } from '../../helpers.js'
 import { client } from '../../../fmEngine/index.js'
-import { getUser, getUserDisplayName, upsertUserDisplayName } from '../../../databaseEngine/index.js'
-import { graphEngine } from '../../../graphEngine/index.js'
+import { getUserDisplayName, upsertUserDisplayName } from '../../../databaseEngine/index.js'
 import { hashName } from '../../../utils.js'
+import { addUserToGroupList, linkArtistNameToMbid } from '../../../graphEngine/operations.js'
+import { getCountPastCrownHolders, tryToStealCrown } from '../../../graphEngine/operations/crowns.js'
 
 type Args = {
   artistName: string
@@ -12,7 +12,7 @@ type InternalArtistType = { name: string, mbid: string | undefined, imageURL: st
 
 export default async (ctx: Context, { artistName }: Args) => {
   await upsertUserDisplayName(ctx.author.name, ctx.registeredUserData.fmUsername)
-  await graphEngine.addMemberToGroupList(ctx.channel.id, ctx.registeredUserData.fmUsername)
+  await addUserToGroupList(ctx.channel.id, ctx.registeredUserData.fmUsername)
   let artist: InternalArtistType | undefined = undefined
   if (!artistName) {
     // get now playing and retrieve artist from there
@@ -31,11 +31,11 @@ export default async (ctx: Context, { artistName }: Args) => {
     mbid: artist?.mbid || artObject.mbid,
   }
   if (!internalArt.mbid) internalArt.mbid = hashName(internalArt.name)
-  await graphEngine.linkArtistNameToMbid(internalArt.name, internalArt.mbid)
+  await linkArtistNameToMbid(internalArt.name, internalArt.mbid, artObject.imageURL)
 
   // try to take the crown
-  const attempt = await graphEngine.tryToStealCrown(ctx.channel.id, internalArt!.mbid!, ctx.registeredUserData.fmUsername.toLowerCase(), artistName, internalArt.playCount)
-  const holders = await graphEngine.getPastCrownHoldersCount(ctx.channel.id, internalArt.mbid)
+  const attempt = await tryToStealCrown(ctx.channel.id, internalArt!.mbid!, ctx.registeredUserData.fmUsername.toLowerCase(), artistName, internalArt.playCount)
+  const holders = await getCountPastCrownHolders(ctx.channel.id, internalArt.mbid)
   const pastHolders = holders.map((r) => ctx.t('commands:whoknows.pastHolder', { name: r.name, playCount: r.playCount }))
   const currentHolder = attempt.crown ? ctx.t('commands:whoknows.currentHolder', {
     name: await getUserDisplayName(attempt.crown.fmusername).then((r: any) => r?.displayName ?? attempt.crown!.fmusername),
@@ -68,7 +68,7 @@ export default async (ctx: Context, { artistName }: Args) => {
 }
 
 export const info = {
-  aliases: ['wk', 'coroa', 'crown'],
+  aliases: ['wka', 'coroa', 'crown'],
   args: [{
     name: 'artistName',
     required: false,
diff --git a/src/commandEngine/commands/targetable/album.ts b/src/commandEngine/commands/targetable/album.ts
@@ -1,13 +1,17 @@
 import { Context } from '../../../multiplatformEngine/common/context.js'
 import { getNowPlaying } from '../../../fmEngine/completeNowPlaying.js'
+import { checkIfUserHasCrown } from '../../../graphEngine/operations/crowns.js'
 
 export default async (ctx: Context) => {
   const data = await getNowPlaying(ctx, 'album')
   const user = ctx.targetedUser ?? ctx.registeredUser
   const userData = ctx.targetedUserData ?? ctx.registeredUserData
 
+  const hasCrown = await checkIfUserHasCrown(ctx.channel.id, userData.fmUsername, data.artistMbid)
+
   ctx.reply(`commands:album`, {
     user: user.name,
+    artistCrown: hasCrown ? '👑' : '🧑‍🎤',
     isListening: data.isNowPlaying ? 'isPlaying' : 'wasPlaying',
     artist: data.artist,
     album: data.album,
diff --git a/src/commandEngine/commands/targetable/artist.ts b/src/commandEngine/commands/targetable/artist.ts
@@ -1,17 +1,20 @@
 import { Context } from '../../../multiplatformEngine/common/context.js'
 import { getNowPlaying } from '../../../fmEngine/completeNowPlaying.js'
-import { graphEngine } from '../../../graphEngine/index.js'
 import { warn } from '../../../loggingEngine/logging.js'
+import { checkIfUserHasCrown } from '../../../graphEngine/operations/crowns.js'
 
 export default async (ctx: Context) => {
   const data = await getNowPlaying(ctx, 'artist')
   const user = ctx.targetedUser ?? ctx.registeredUser
   const userData = ctx.targetedUserData ?? ctx.registeredUserData
 
+  const hasCrown = await checkIfUserHasCrown(ctx.channel.id, userData.fmUsername, data.artistMbid)
+
   if (!data.mbid) warn('commands.artist', `no mbid found for ${data.artist}`)
-  if (data.playCount && data.playCount > 1 && data.mbid) await graphEngine.upsertScrobbles(ctx.registeredUserData.fmUsername, data.mbid, data.playCount)
+
   ctx.reply(`commands:artist`, {
     user: user.name,
+    artistCrown: hasCrown ? '👑' : '🧑‍🎤',
     isListening: data.isNowPlaying ? 'isPlaying' : 'wasPlaying',
     artist: data.artist,
     playCount: data.playCount,
diff --git a/src/commandEngine/commands/targetable/listening.ts b/src/commandEngine/commands/targetable/listening.ts
@@ -1,13 +1,17 @@
 import { Context } from '../../../multiplatformEngine/common/context.js'
 import { getNowPlaying } from '../../../fmEngine/completeNowPlaying.js'
+import { checkIfUserHasCrown } from '../../../graphEngine/operations/crowns.js'
 
 export default async (ctx: Context) => {
   const data = await getNowPlaying(ctx, 'track')
   const user = ctx.targetedUser ?? ctx.registeredUser
   const userData = ctx.targetedUserData ?? ctx.registeredUserData
 
+  const hasCrown = await checkIfUserHasCrown(ctx.channel.id, userData.fmUsername, data.artistMbid)
+
   ctx.reply(`commands:listening`, {
     user: user.name,
+    artistCrown: hasCrown ? '👑' : '🧑‍🎤',
     isListening: data.isNowPlaying ? 'isPlaying' : 'wasPlaying',
     track: data.name,
     artist: data.artist,
diff --git a/src/commandEngine/commands/targeted+registered/mealbum.ts b/src/commandEngine/commands/targeted+registered/mealbum.ts
@@ -6,7 +6,6 @@ export default async (ctx: Context) => {
 
   ctx.reply(`commands:mealbum`, {
     user: ctx.registeredUser?.name,
-    isListening: data.isNowPlaying ? 'isPlaying' : 'wasPlaying',
     artist: data.artist,
     album: data.album,
     playCount: data.playCount,
diff --git a/src/commandEngine/commands/targeted+registered/meartist.ts b/src/commandEngine/commands/targeted+registered/meartist.ts
@@ -6,7 +6,6 @@ export default async (ctx: Context) => {
 
   ctx.reply(`commands:meartist`, {
     user: ctx.registeredUser?.name,
-    isListening: data.isNowPlaying ? 'isPlaying' : 'wasPlaying',
     artist: data.artist,
     playCount: data.playCount,
     tags: ctx.registeredUserData.sendTags ? `\n*${data.tags.map(a => `#${a}`).join(' ')}*` : '',
diff --git a/src/commandEngine/commands/targeted+registered/metrack.ts b/src/commandEngine/commands/targeted+registered/metrack.ts
@@ -6,7 +6,6 @@ export default async (ctx: Context) => {
 
   ctx.reply(`commands:youtrack`, {
     user: ctx.registeredUser?.name,
-    isListening: data.isNowPlaying ? 'isPlaying' : 'wasPlaying',
     track: data.name,
     artist: data.artist,
     album: data.album,
diff --git a/src/fmEngine/completeNowPlaying.ts b/src/fmEngine/completeNowPlaying.ts
@@ -5,13 +5,14 @@ import { LastfmRecentTracksTrack } from '@musicorum/lastfm/dist/types/packages/u
 import { LastfmTag } from '@musicorum/lastfm/dist/types/packages/common.js'
 import { debug } from '../loggingEngine/logging.js'
 import { hashName } from '../utils.js'
-import { graphEngine } from '../graphEngine/index.js'
+import { upsertArtistScrobbles } from '../graphEngine/operations/artist-scrobbles.js'
 
 export type NowPlayingEntity = 'artist' | 'album' | 'track'
 
 export interface NowPlayingData<NowPlayingEntity> {
   name: string
-  mbid?: string
+  mbid: string
+  artistMbid: string
   imageURL: string
   artist?: string
   album?: string
@@ -26,7 +27,9 @@ const entityCall = async (entity: NowPlayingEntity, username: string, track: Las
 
   switch (entity) {
     case 'artist':
-      return client.artist.getInfo(track.artist.name, data)
+      const d = await client.artist.getInfo(track.artist.name, data)
+      if (d?.playCount && d?.playCount > 1 && d?.mbid) await upsertArtistScrobbles(username, d?.mbid, d?.playCount)
+      return d
     case 'album':
       return client.album.getInfo(track.album.name, track.artist.name, data)
     case 'track':
@@ -54,12 +57,20 @@ export const getNowPlaying = async (ctx: Context, entity: NowPlayingEntity, getF
     track
   ).catch(() => undefined)
 
-  let tags = info.tags?.map?.((tag: LastfmTag) => tag.name ?? tag) || []
+  let tags = info?.tags?.map?.((tag: LastfmTag) => tag.name ?? tag) || []
   tags = tags.map((a: string) => a.toLowerCase().replaceAll('-', '_').replaceAll(' ', '_'))
 
+  let artistMbid
+  if (entity === 'track' || entity === 'album') {
+    artistMbid = track.artist.mbid || hashName(track.artist.name)
+  } else {
+    artistMbid = info?.mbid
+  }
+
   return {
     name: track.name,
     mbid: info.mbid || hashName(track.name),
+    artistMbid,
     imageURL: info.images?.[3]?.url || track?.images?.[3]?.url,
     artist: track.artist.name,
     album: track.album.name || info.album?.name,
diff --git a/src/graphEngine/index.ts b/src/graphEngine/index.ts
@@ -1,96 +1,17 @@
 import { createKeyspace, createTables } from './migrations.js'
 import { Client } from 'cassandra-driver'
 import { debug, error } from '../loggingEngine/logging.js'
-import {
-  getCrown,
-  upsertArtistScrobble,
-  getUserCrowns,
-  tryGetToCrown,
-  addUserToGroupList,
-  getCountPastCrownHolders, linkArtistNameToMbid, getArtistNameFromMbid
-} from './operations.js'
 
-const client = new Client({
+export const client = new Client({
   contactPoints: [process.env.CASSANDRA_HOST || 'localhost'],
   localDataCenter: 'datacenter1'
 })
 
-class GraphEngine {
-  hasStarted: boolean = false
-  client: Client | undefined = undefined
-
-  upsertScrobbles (fmUsername: string, artistMbid: string, playCount: number) {
-    if (!this.hasStarted) {
-      throw new Error('GraphEngine has not started')
-    }
-    debug('graphEngine.upsertScrobbles', `upserting scrobbles for ${fmUsername} on ${artistMbid} with playcount ${playCount}`)
-    return upsertArtistScrobble(this.client!, fmUsername, artistMbid, playCount)
-  }
-
-  getCrownOnGroup (groupId: string, artistMbid: string) {
-    if (!this.hasStarted) {
-      throw new Error('GraphEngine has not started')
-    }
-    return getCrown(this.client!, groupId, artistMbid)
-  }
-
-  getUserCrowns (groupId: string, fmUsername: string) {
-    if (!this.hasStarted) {
-      throw new Error('GraphEngine has not started')
-    }
-    return getUserCrowns(this.client!, groupId, fmUsername)
-  }
-
-  tryToStealCrown (groupId: string, artistMbid: string, fmUsername: string, artistName: string, playCount: number = 0) {
-    if (!this.hasStarted) {
-      throw new Error('GraphEngine has not started')
-    }
-    return tryGetToCrown(this.client!, groupId, artistMbid, fmUsername, artistName, playCount)
-  }
-
-  addMemberToGroupList (groupId: string, fmUsername: string) {
-    if (!this.hasStarted) {
-      throw new Error('GraphEngine has not started')
-    }
-    return addUserToGroupList(this.client!, groupId, fmUsername).then(() => debug('graphEngine.addMemberToGroupList', `added ${fmUsername} to group ${groupId}`))
-  }
-
-  setClient (client: Client) {
-    this.client = client
-    this.hasStarted = true
-  }
-
-  getPastCrownHoldersCount (groupId: string, artistMbid: string) {
-    if (!this.hasStarted) {
-      throw new Error('GraphEngine has not started')
-    }
-    return getCountPastCrownHolders(this.client!, groupId, artistMbid)
-  }
-
-  linkArtistNameToMbid (artistName: string, artistMbid: string | undefined) {
-    if (!this.hasStarted) {
-      throw new Error('GraphEngine has not started')
-    }
-    return linkArtistNameToMbid(this.client!, artistName, artistMbid)
-  }
-
-  getArtistNameByMbid (artistMbid: string) {
-    if (!this.hasStarted) {
-      throw new Error('GraphEngine has not started')
-    }
-
-    return getArtistNameFromMbid(this.client!, artistMbid)
-  }
-}
-
-export const graphEngine = new GraphEngine()
-
 export const start = async () => {
   await client.connect().then(() => debug('graphEngine.main', 'connected to database'))
   await createKeyspace(client).then(() => debug('graphEngine.main', 'keyspace created')).catch((e) => error('graphEngine.main', e.stack))
   client.keyspace = 'lastgram'
 
   await createTables(client).then(() => debug('graphEngine.main', 'tables created')).catch((e) => error('graphEngine.main', e.stack))
-  graphEngine.setClient(client)
 }
 
diff --git a/src/graphEngine/migrations.ts b/src/graphEngine/migrations.ts
@@ -40,7 +40,7 @@ export const createTables = async (client: Client) => {
       fmUsername text,
       playCount int,
       createdAt timestamp,
-      PRIMARY KEY (groupId, artistMbid)
+      PRIMARY KEY (groupId, artistMbid, fmUsername)
     );
   `
 
@@ -49,6 +49,7 @@ export const createTables = async (client: Client) => {
     CREATE TABLE IF NOT EXISTS artist_mbid_map (
       artistName text,
       artistMbid text,
+      artistCover text,
       PRIMARY KEY (artistName, artistMbid)
     );
   `
diff --git a/src/graphEngine/operations.ts b/src/graphEngine/operations.ts
diff --git a/src/graphEngine/operations/artist-scrobbles.ts b/src/graphEngine/operations/artist-scrobbles.ts
diff --git a/src/graphEngine/operations/crowns.ts b/src/graphEngine/operations/crowns.ts
