fix missing remote event handlers (#1344)

This commit is contained in:
jeffvli
2025-12-13 20:58:12 -08:00
parent 5c8d18d1c9
commit f61d34c340
4 changed files with 345 additions and 20 deletions
+130 -15
View File
@@ -1,11 +1,13 @@
import isElectron from 'is-electron';
import { useEffect } from 'react';
import { useEffect, useRef } from 'react';
import { usePlayerEvents } from '/@/renderer/features/player/audio-player/hooks/use-player-events';
import { useCreateFavorite } from '/@/renderer/features/shared/mutations/create-favorite-mutation';
import { useDeleteFavorite } from '/@/renderer/features/shared/mutations/delete-favorite-mutation';
import { useSetRating } from '/@/renderer/features/shared/mutations/set-rating-mutation';
import { usePlayerActions, useRemoteSettings } from '/@/renderer/store';
import { usePlayerActions, usePlayerStore, useRemoteSettings } from '/@/renderer/store';
import { LogCategory, logFn } from '/@/renderer/utils/logger';
import { logMsg } from '/@/renderer/utils/logger-message';
import { toast } from '/@/shared/components/toast/toast';
import { LibraryItem } from '/@/shared/types/domain-types';
import { PlayerShuffle } from '/@/shared/types/types';
@@ -14,19 +16,31 @@ const remote = isElectron() ? window.api.remote : null;
const ipc = isElectron() ? window.api.ipc : null;
export const useRemote = () => {
const { mediaSkipForward, setTimestamp, setVolume } = usePlayerActions();
const { mediaSkipForward, setVolume } = usePlayerActions();
const player = usePlayerStore();
const remoteSettings = useRemoteSettings();
const updateRatingMutation = useSetRating({});
const addToFavoritesMutation = useCreateFavorite({});
const removeFromFavoritesMutation = useDeleteFavorite({});
const isRemoteEnabled = remoteSettings.enabled;
// Initialize the remote
useEffect(() => {
if (!remote) {
if (!isRemoteEnabled) {
return;
}
logFn.debug(logMsg[LogCategory.REMOTE].initializingRemoteSettings, {
category: LogCategory.REMOTE,
meta: {
enabled: remoteSettings.enabled,
port: remoteSettings.port,
username: remoteSettings.username,
},
});
remote
?.updateSetting(
remoteSettings.enabled,
@@ -35,6 +49,10 @@ export const useRemote = () => {
remoteSettings.password,
)
.catch((error) => {
logFn.error(logMsg[LogCategory.REMOTE].failedToEnableRemote, {
category: LogCategory.REMOTE,
meta: { error },
});
toast.warn({ message: error, title: 'Failed to enable remote' });
});
// We only want to fire this once
@@ -42,21 +60,33 @@ export const useRemote = () => {
}, []);
useEffect(() => {
if (!remote) {
if (!isRemoteEnabled || !remote) {
return;
}
remote.requestPosition((_e: unknown, data: { position: number }) => {
logFn.debug(logMsg[LogCategory.REMOTE].requestPositionReceived, {
category: LogCategory.REMOTE,
meta: { position: data.position },
});
const newTime = data.position;
setTimestamp(newTime);
player.mediaSeekToTimestamp(newTime);
});
remote.requestSeek((_e: unknown, data: { offset: number }) => {
logFn.debug(logMsg[LogCategory.REMOTE].requestSeekReceived, {
category: LogCategory.REMOTE,
meta: { offset: data.offset },
});
mediaSkipForward(data.offset);
});
remote.requestRating(
(_e: unknown, data: { id: string; rating: number; serverId: string }) => {
logFn.debug(logMsg[LogCategory.REMOTE].requestRatingReceived, {
category: LogCategory.REMOTE,
meta: { id: data.id, rating: data.rating, serverId: data.serverId },
});
updateRatingMutation.mutate({
apiClientProps: { serverId: data.serverId },
query: {
@@ -69,11 +99,19 @@ export const useRemote = () => {
);
remote.requestVolume((_e: unknown, data: { volume: number }) => {
logFn.debug(logMsg[LogCategory.REMOTE].requestVolumeReceived, {
category: LogCategory.REMOTE,
meta: { volume: data.volume },
});
setVolume(data.volume);
});
remote.requestFavorite(
(_e: unknown, data: { favorite: boolean; id: string; serverId: string }) => {
logFn.debug(logMsg[LogCategory.REMOTE].requestFavoriteReceived, {
category: LogCategory.REMOTE,
meta: { favorite: data.favorite, id: data.id, serverId: data.serverId },
});
const mutator = data.favorite
? addToFavoritesMutation
: removeFromFavoritesMutation;
@@ -96,63 +134,140 @@ export const useRemote = () => {
};
}, [
addToFavoritesMutation,
isRemoteEnabled,
mediaSkipForward,
player,
removeFromFavoritesMutation,
setTimestamp,
setVolume,
updateRatingMutation,
]);
// Send initial song if one is already playing
const isInitializedRef = useRef(false);
useEffect(() => {
if (isInitializedRef.current || !isRemoteEnabled || !remote) {
return;
}
isInitializedRef.current = true;
const currentSong = player.getCurrentSong();
if (currentSong) {
logFn.debug(logMsg[LogCategory.REMOTE].sendingInitialSong, {
category: LogCategory.REMOTE,
meta: {
artistName: currentSong.artistName,
id: currentSong.id,
name: currentSong.name,
},
});
remote.updateSong(currentSong);
}
}, [isRemoteEnabled, player]);
usePlayerEvents(
{
onPlayerProgress: (properties) => {
if (!remote) {
onCurrentSongChange: (properties) => {
if (!isRemoteEnabled || !remote) {
return;
}
logFn.debug(logMsg[LogCategory.REMOTE].updateSongSent, {
category: LogCategory.REMOTE,
meta: {
artistName: properties.song?.artistName,
id: properties.song?.id,
index: properties.index,
name: properties.song?.name,
},
});
remote.updateSong(properties.song);
},
onPlayerProgress: (properties) => {
if (!isRemoteEnabled || !remote) {
return;
}
logFn.debug(logMsg[LogCategory.REMOTE].updatePositionSent, {
category: LogCategory.REMOTE,
meta: { timestamp: properties.timestamp },
});
remote.updatePosition(properties.timestamp);
},
onPlayerRepeat: (properties) => {
if (!remote) {
if (!isRemoteEnabled || !remote) {
return;
}
logFn.debug(logMsg[LogCategory.REMOTE].updateRepeatSent, {
category: LogCategory.REMOTE,
meta: { repeat: properties.repeat },
});
remote.updateRepeat(properties.repeat);
},
onPlayerShuffle: (properties) => {
if (!remote) {
if (!isRemoteEnabled || !remote) {
return;
}
const isShuffleEnabled = properties.shuffle !== PlayerShuffle.NONE;
logFn.debug(logMsg[LogCategory.REMOTE].updateShuffleSent, {
category: LogCategory.REMOTE,
meta: { isShuffleEnabled, shuffle: properties.shuffle },
});
remote.updateShuffle(isShuffleEnabled);
},
onPlayerStatus: (properties) => {
if (!remote) {
if (!isRemoteEnabled || !remote) {
return;
}
logFn.debug(logMsg[LogCategory.REMOTE].updatePlaybackSent, {
category: LogCategory.REMOTE,
meta: { status: properties.status },
});
remote.updatePlayback(properties.status);
},
onPlayerVolume: (properties) => {
if (!remote) {
if (!isRemoteEnabled || !remote) {
return;
}
logFn.debug(logMsg[LogCategory.REMOTE].updateVolumeSent, {
category: LogCategory.REMOTE,
meta: { volume: properties.volume },
});
remote.updateVolume(properties.volume);
},
onUserFavorite: (properties) => {
if (!remote) {
if (!isRemoteEnabled || !remote) {
return;
}
logFn.debug(logMsg[LogCategory.REMOTE].updateFavoriteSent, {
category: LogCategory.REMOTE,
meta: {
favorite: properties.favorite,
id: properties.id,
serverId: properties.serverId,
},
});
remote.updateFavorite(properties.favorite, properties.serverId, properties.id);
},
onUserRating: (properties) => {
if (!remote) {
if (!isRemoteEnabled || !remote) {
return;
}
logFn.debug(logMsg[LogCategory.REMOTE].updateRatingSent, {
category: LogCategory.REMOTE,
meta: {
id: properties.id,
rating: properties.rating || 0,
serverId: properties.serverId,
},
});
remote.updateRating(properties.rating || 0, properties.serverId, properties.id);
},
},
+44
View File
@@ -60,6 +60,50 @@ export const logMsg = {
toggleRepeat: 'Toggle repeat',
toggleShuffle: 'Toggle shuffle',
},
[LogCategory.REMOTE]: {
cannotSendEvent: 'Cannot send event - socket not available',
closingExistingSocket: 'Closing existing socket',
creatingWebSocket: 'Creating new WebSocket',
credentialsFetched: 'Credentials fetched',
failedToEnableRemote: 'Failed to enable remote',
failedToGetCredentials: 'Failed to get credentials',
favoriteEventReceived: 'Favorite event received',
fetchingCredentials: 'Fetching credentials',
initializingRemoteSettings: 'Initializing remote settings',
playbackEventReceived: 'Playback event received',
positionEventReceived: 'Position event received',
proxyEventReceived: 'Proxy event received (image update)',
ratingEventReceived: 'Rating event received',
reconnectInitiated: 'Reconnect initiated',
reloadingPage: 'Reloading page due to close code',
repeatEventReceived: 'Repeat event received',
requestFavoriteReceived: 'Request favorite received',
requestPositionReceived: 'Request position received',
requestRatingReceived: 'Request rating received',
requestSeekReceived: 'Request seek received',
requestVolumeReceived: 'Request volume received',
sendingAuthentication: 'Sending authentication',
sendingEventToServer: 'Sending event to server',
sendingInitialSong: 'Sending initial song',
serverIsDown: 'Server is down',
shuffleEventReceived: 'Shuffle event received',
socketClosedUnexpectedly: 'Socket closed unexpectedly',
songEventReceived: 'Song event received',
stateEventReceived: 'State event received (full state update)',
updateFavoriteSent: 'Update favorite sent',
updatePlaybackSent: 'Update playback sent',
updatePositionSent: 'Update position sent',
updateRatingSent: 'Update rating sent',
updateRepeatSent: 'Update repeat sent',
updateShuffleSent: 'Update shuffle sent',
updateSongSent: 'Update song sent',
updateVolumeSent: 'Update volume sent',
volumeEventReceived: 'Volume event received',
webSocketClosed: 'WebSocket closed',
webSocketErrorEvent: 'WebSocket error event',
webSocketMessageReceived: 'WebSocket message received',
webSocketOpened: 'WebSocket opened',
},
[LogCategory.SCROBBLE]: {
scrobbledPause: 'Scrobbled a pause event',
scrobbledStart: 'Scrobbled a start event',
+1
View File
@@ -7,6 +7,7 @@ export enum LogCategory {
GENERAL = 'general',
OTHER = 'other',
PLAYER = 'player',
REMOTE = 'remote',
SCROBBLE = 'scrobble',
SYSTEM = 'system',
}