clean up discord rpc implementation with usePlayerEvents

src/renderer/features/discord-rpc/use-discord-rpc.ts

@@ -5,6 +5,7 @@ import React, { useCallback, useEffect, useRef, useState } from 'react';
 
 import { api } from '/@/renderer/api';
 import { useItemImageUrl } from '/@/renderer/components/item-image/item-image';
+import { usePlayerEvents } from '/@/renderer/features/player/audio-player/hooks/use-player-events';
 import {
     useIsRadioActive,
     useRadioPlayer,
@@ -36,6 +37,7 @@ const DiscordStatusDisplayType = {
 } as const;
 
 type ActivityState = [QueueSong | undefined, number, PlayerStatus];
+type ActivityTrigger = 'initial' | 'interval' | 'seek' | 'status_change' | 'track_change';
 
 const MAX_FIELD_LENGTH = 127;
 const MAX_URL_LENGTH = 256;
@@ -64,22 +66,24 @@ export const useDiscordRpc = () => {
     const imageUrlRef = useRef<null | string | undefined>(imageUrl);
     const previousEnabledRef = useRef<boolean>(discordSettings.enabled);
     const intervalRef = useRef<NodeJS.Timeout | null>(null);
-    const previousActivityStateRef = useRef<ActivityState | null>(null);
+    const discordEnabledRef = useRef<boolean>(discordSettings.enabled);
+    const privateModeRef = useRef<boolean>(privateMode);
 
-    // Update imageUrl ref when it changes
     useEffect(() => {
         imageUrlRef.current = imageUrl;
     }, [imageUrl]);
 
+    useEffect(() => {
+        discordEnabledRef.current = discordSettings.enabled;
+    }, [discordSettings.enabled]);
+
+    useEffect(() => {
+        privateModeRef.current = privateMode;
+    }, [privateMode]);
+
     const setActivity = useCallback(
-        async (current: ActivityState, previous: ActivityState) => {
+        async (current: ActivityState, trigger: ActivityTrigger) => {
-            // Check if track changed by comparing with previous state
             const song = current[0];
-            const previousSong = previous[0];
-            const trackChangedByState =
-                song && previousSong
-                    ? song._uniqueId !== previousSong._uniqueId
-                    : song !== previousSong;
             const trackChanged = song ? lastUniqueId !== song._uniqueId : false;
 
             const isPlayingRadio = isRadioActive && isRadioPlaying;
@@ -103,6 +107,7 @@ export const useDiscordRpc = () => {
                     meta: {
                         reason,
                         status: current[2],
+                        trigger,
                     },
                 });
                 return discordRpc?.clearActivity();
@@ -152,6 +157,7 @@ export const useDiscordRpc = () => {
                         showAsListening: discordSettings.showAsListening,
                         stationName: stationName || 'Radio',
                         title,
+                        trigger,
                     },
                 });
                 discordRpc?.setActivity(activity);
@@ -162,20 +168,7 @@ export const useDiscordRpc = () => {
                 return;
             }
 
-            /*
+            if (trackChanged) {
-                1. If the song has just started, update status
-                2. If we jump more then 1.2 seconds from last state, update status to match
-                3. If the current song id is completely different, update status
-                4. If the player state changed, update status
-            */
-            if (
-                previous[1] === 0 ||
-                Math.abs(current[1] - previous[1]) > 1.2 ||
-                trackChangedByState ||
-                trackChanged ||
-                current[2] !== previous[2]
-            ) {
-                if (trackChangedByState || trackChanged) {
                 logFn.debug(logMsg[LogCategory.EXTERNAL].discordRpcTrackChanged, {
                     category: LogCategory.EXTERNAL,
                     meta: {
@@ -187,17 +180,7 @@ export const useDiscordRpc = () => {
                 setlastUniqueId(song._uniqueId);
             }
 
-                let reason: string;
+            const reason = trigger;
-                if (trackChangedByState || trackChanged) {
-                    reason = 'track_changed';
-                } else if (previous[1] === 0) {
-                    reason = 'song_started';
-                } else if (Math.abs(current[1] - previous[1]) > 1.2) {
-                    reason = 'time_jump';
-                } else {
-                    reason = 'player_state_changed';
-                }
-
             const start = Math.round(Date.now() - current[1] * 1000);
             const end = Math.round(start + song.duration);
 
@@ -348,28 +331,14 @@ export const useDiscordRpc = () => {
                     displayType: discordSettings.displayType,
                     hasLargeImage: !!activity.largeImageKey,
                     hasTimestamps: !!(activity.startTimestamp && activity.endTimestamp),
-                        previousStatus: previous[2],
-                        previousTime: previous[1],
                     reason,
                     showAsListening: discordSettings.showAsListening,
                     songName: song.name,
-                        trackChanged: trackChangedByState || trackChanged,
+                    trackChanged,
+                    trigger,
                 },
             });
             discordRpc?.setActivity(activity);
-            } else {
-                logFn.debug(logMsg[LogCategory.EXTERNAL].discordRpcUpdateSkipped, {
-                    category: LogCategory.EXTERNAL,
-                    meta: {
-                        currentStatus: current[2],
-                        currentTime: current[1],
-                        previousStatus: previous[2],
-                        previousTime: previous[1],
-                        timeDiff: Math.abs(current[1] - previous[1]),
-                        trackChanged: trackChangedByState || trackChanged,
-                    },
-                });
-            }
         },
         [
             discordSettings.showAsListening,
@@ -390,7 +359,7 @@ export const useDiscordRpc = () => {
         ],
     );
 
-    const debouncedSetActivity = useDebouncedCallback(setActivity, 500);
+    const debouncedSetActivity = useDebouncedCallback(setActivity, 1000);
 
     // Quit Discord RPC if it was enabled and is now disabled
     useEffect(() => {
@@ -409,95 +378,110 @@ export const useDiscordRpc = () => {
         }
     }, [discordSettings.clientId, privateMode, discordSettings.enabled]);
 
-    useEffect(() => {
+    const getCurrentActivityState = useCallback((): ActivityState => {
-        if (!discordSettings.enabled || privateMode) {
-            return;
-        }
-
-        const getCurrentActivityState = (): ActivityState => {
         const state = usePlayerStore.getState();
-            const currentSong = state.getCurrentSong();
+        return [
-            const currentTime = useTimestampStoreBase.getState().timestamp;
+            state.getCurrentSong(),
-            const status = state.player.status;
+            useTimestampStoreBase.getState().timestamp,
-            return [currentSong, currentTime, status];
+            state.player.status,
-        };
-
-        const resetInterval = () => {
-            if (intervalRef.current) {
-                clearInterval(intervalRef.current);
-            }
-            intervalRef.current = setInterval(() => {
-                const current = getCurrentActivityState();
-                const previous = previousActivityStateRef.current || current;
-                debouncedSetActivity(current, previous);
-                previousActivityStateRef.current = current;
-            }, 15000);
-        };
-
-        resetInterval();
-
-        const initialState = getCurrentActivityState();
-        let previousUniqueId = initialState[0]?._uniqueId || '';
-
-        previousActivityStateRef.current = initialState;
-
-        // Set activity immediately when Discord RPC is enabled
-        debouncedSetActivity(initialState, initialState);
-
-        const unsubSongChange = usePlayerStore.subscribe(
-            (state): ActivityState => {
-                const currentSong = state.getCurrentSong();
-                const currentTime = useTimestampStoreBase.getState().timestamp;
-                const status = state.player.status;
-
-                return [currentSong, currentTime, status];
-            },
-            (current, previous) => {
-                const currentUniqueId = current[0]?._uniqueId || '';
-                const trackChanged = previousUniqueId !== currentUniqueId;
-
-                if (trackChanged && current[0]) {
-                    resetInterval();
-                    previousUniqueId = currentUniqueId;
-                }
-
-                const activity: ActivityState = [
-                    current[0] as QueueSong,
-                    current[1] as number,
-                    current[2] as PlayerStatus,
         ];
+    }, []);
 
-                // Use the ref as the source of truth for previous state
+    const clearRefreshInterval = useCallback(() => {
-                const previousActivity: ActivityState =
-                    previousActivityStateRef.current ||
-                    (previous
-                        ? [
-                              previous[0] as QueueSong,
-                              previous[1] as number,
-                              previous[2] as PlayerStatus,
-                          ]
-                        : activity);
-
-                debouncedSetActivity(activity, previousActivity);
-
-                previousActivityStateRef.current = activity;
-            },
-        );
-
-        return () => {
-            unsubSongChange();
         if (intervalRef.current) {
             clearInterval(intervalRef.current);
             intervalRef.current = null;
         }
+    }, []);
+
+    const emitActivityUpdateRef = useRef<(next: ActivityState, trigger: ActivityTrigger) => void>(
+        () => {},
+    );
+
+    const resetRefreshInterval = useCallback(() => {
+        clearRefreshInterval();
+        intervalRef.current = setInterval(() => {
+            const current = getCurrentActivityState();
+            emitActivityUpdateRef.current(current, 'interval');
+        }, 15000);
+    }, [clearRefreshInterval, getCurrentActivityState]);
+
+    const emitActivityUpdate = useCallback(
+        (next: ActivityState, trigger: ActivityTrigger) => {
+            debouncedSetActivity(next, trigger);
+            resetRefreshInterval();
+        },
+        [debouncedSetActivity, resetRefreshInterval],
+    );
+
+    useEffect(() => {
+        emitActivityUpdateRef.current = emitActivityUpdate;
+    }, [emitActivityUpdate]);
+
+    useEffect(() => {
+        if (!discordSettings.enabled || privateMode) {
+            clearRefreshInterval();
+            return;
+        }
+
+        const initialState = getCurrentActivityState();
+        emitActivityUpdate(initialState, 'initial');
+
+        return () => {
+            clearRefreshInterval();
         };
     }, [
-        debouncedSetActivity,
+        clearRefreshInterval,
-        discordSettings.clientId,
         discordSettings.enabled,
+        emitActivityUpdate,
+        getCurrentActivityState,
         privateMode,
-        setActivity,
     ]);
+
+    usePlayerEvents(
+        {
+            onCurrentSongChange: ({ song }) => {
+                if (!discordEnabledRef.current || privateModeRef.current) {
+                    return;
+                }
+
+                const playerState = usePlayerStore.getState();
+                const activityState: ActivityState = [
+                    song,
+                    useTimestampStoreBase.getState().timestamp,
+                    playerState.player.status,
+                ];
+                emitActivityUpdateRef.current(activityState, 'track_change');
+            },
+            onPlayerSeekToTimestamp: ({ timestamp }) => {
+                if (!discordEnabledRef.current || privateModeRef.current) {
+                    return;
+                }
+
+                const playerState = usePlayerStore.getState();
+                const activityState: ActivityState = [
+                    playerState.getCurrentSong(),
+                    timestamp,
+                    playerState.player.status,
+                ];
+                emitActivityUpdateRef.current(activityState, 'seek');
+            },
+            onPlayerStatus: ({ status }) => {
+                if (!discordEnabledRef.current || privateModeRef.current) {
+                    return;
+                }
+
+                const playerState = usePlayerStore.getState();
+                const activityState: ActivityState = [
+                    playerState.getCurrentSong(),
+                    useTimestampStoreBase.getState().timestamp,
+                    status,
+                ];
+                emitActivityUpdateRef.current(activityState, 'status_change');
+            },
+        },
+        [],
+    );
 };
 
 const DiscordRpcHookInner = () => {