vanja/feishin
1
0
Fork 0
mirror of https://github.com/jeffvli/feishin.git synced 2026-06-23 20:37:42 +02:00
Code Issues Packages Projects Releases Wiki Activity

optimize rating/favorite to prevent blocking UI

Browse Source
This commit is contained in:
jeffvli
2026-01-21 01:38:11 -08:00
parent b7cbb3055a
commit 0492b867aa
2 changed files with 1303 additions and 1063 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/renderer/features/shared/mutations/favorite-optimistic-updates.ts
+391 -315
View File
File diff suppressed because it is too large Load Diff
src/renderer/features/shared/mutations/rating-optimistic-updates.ts
+381 -217
View File
@@ -18,12 +18,69 @@ import {
TopSongListResponse,
} from '/@/shared/types/domain-types';
interface PendingUpdate {
previousData: unknown;
queryKey: readonly unknown[];
updater: (prev: any) => any;
}
function collectAndApplyUpdates(
queryClient: QueryClient,
pendingUpdates: PendingUpdate[],
): PreviousQueryData[] {
const previousQueries: PreviousQueryData[] = [];
// Batch all updates together - React Query will batch these internally
pendingUpdates.forEach(({ previousData, queryKey, updater }) => {
previousQueries.push({ data: previousData, queryKey });
queryClient.setQueryData(queryKey, updater);
});
return previousQueries;
}
function updateItemInArray<T extends { id: string }>(
items: T[],
itemIdSet: Set<string>,
updater: (item: T) => T,
): null | T[] {
let hasChanges = false;
const updatedItems = items.map((item) => {
if (itemIdSet.has(item.id)) {
hasChanges = true;
return updater(item);
}
return item;
});
return hasChanges ? updatedItems : null;
}
function updateItemsInPages<T extends { id: string }, P extends { items: T[] }>(
pages: P[],
itemIdSet: Set<string>,
updater: (item: T) => T,
): null | P[] {
let hasChanges = false;
const updatedPages = pages.map((page) => {
if (!page) return page;
const updatedItems = updateItemInArray(page.items, itemIdSet, updater);
if (updatedItems) {
hasChanges = true;
return { ...page, items: updatedItems };
}
return page;
});
return hasChanges ? updatedPages : null;
}
export const applyRatingOptimisticUpdates = (
queryClient: QueryClient,
variables: SetRatingArgs,
rating: number,
): PreviousQueryData[] => {
const previousQueries: PreviousQueryData[] = [];
const pendingUpdates: PendingUpdate[] = [];
const itemIdSet = new Set<string>();
if (Array.isArray(variables.query.id)) {
@@ -34,91 +91,83 @@ export const applyRatingOptimisticUpdates = (
itemIdSet.add(variables.query.id);
}
const createRatingUpdater = <T extends { userRating?: null | number }>(item: T): T => ({
...item,
userRating: rating,
});
switch (variables.query.type) {
case LibraryItem.ALBUM: {
const detailQueryKey = queryKeys.albums.detail(variables.apiClientProps.serverId);
const detailQueries = queryClient.getQueriesData({
exact: false,
queryKey: detailQueryKey,
});
if (detailQueries.length) {
detailQueries.forEach(([queryKey, data]) => {
if (data) {
previousQueries.push({ data, queryKey });
queryClient.setQueryData(
pendingUpdates.push({
previousData: data,
queryKey,
(prev: AlbumDetailResponse | undefined) => {
updater: (prev: AlbumDetailResponse | undefined) => {
if (prev && itemIdSet.has(prev.id)) {
return { ...prev, userRating: rating };
}
return prev;
},
);
}
});
}
});
const listQueryKey = queryKeys.albums.list(variables.apiClientProps.serverId);
const listQueries = queryClient.getQueriesData({
exact: false,
queryKey: listQueryKey,
});
if (listQueries.length) {
listQueries.forEach(([queryKey, data]) => {
if (data) {
previousQueries.push({ data, queryKey });
queryClient.setQueryData(queryKey, (prev: AlbumListResponse) => {
return {
...prev,
items: prev.items.map((item: Album) => {
return itemIdSet.has(item.id)
? { ...item, userRating: rating }
: item;
}),
};
pendingUpdates.push({
previousData: data,
queryKey,
updater: (prev: AlbumListResponse | undefined) => {
if (!prev) return prev;
const updatedItems = updateItemInArray(prev.items, itemIdSet, (item) =>
createRatingUpdater<Album>(item),
);
return updatedItems ? { ...prev, items: updatedItems } : prev;
},
});
}
});
}
const infiniteListQueryKey = queryKeys.albums.infiniteList(
variables.apiClientProps.serverId,
);
const infiniteListQueries = queryClient.getQueriesData({
exact: false,
queryKey: infiniteListQueryKey,
});
if (infiniteListQueries.length) {
infiniteListQueries.forEach(([queryKey, data]) => {
if (data) {
previousQueries.push({ data, queryKey });
queryClient.setQueryData(
pendingUpdates.push({
previousData: data,
queryKey,
(prev: { pageParams: string[]; pages: AlbumListResponse[] }) => {
return {
...prev,
pages: prev.pages.map((page: AlbumListResponse) => {
return {
...page,
items: page.items.map((item: Album) => {
return itemIdSet.has(item.id)
? { ...item, userRating: rating }
: item;
}),
};
}),
};
},
updater: (
prev: undefined | { pageParams: string[]; pages: AlbumListResponse[] },
) => {
if (!prev) return prev;
const updatedPages = updateItemsInPages<Album, AlbumListResponse>(
prev.pages.filter((p): p is AlbumListResponse => !!p),
itemIdSet,
(item) => createRatingUpdater<Album>(item),
);
}
return updatedPages ? { ...prev, pages: updatedPages } : prev;
},
});
}
});
// Update infinite loader custom query keys
const infiniteLoaderQueryKey = [
@@ -132,13 +181,12 @@ export const applyRatingOptimisticUpdates = (
queryKey: infiniteLoaderQueryKey,
});
if (infiniteLoaderQueries.length) {
infiniteLoaderQueries.forEach(([queryKey, data]) => {
if (data) {
previousQueries.push({ data, queryKey });
queryClient.setQueryData(
pendingUpdates.push({
previousData: data,
queryKey,
(
updater: (
prev:
| undefined
| {
@@ -147,54 +195,40 @@ export const applyRatingOptimisticUpdates = (
},
) => {
if (prev && prev.data) {
return {
...prev,
data: prev.data.map((item: any) => {
if (!item || !item.id) {
return item;
const updatedData = updateItemInArray(
prev.data as Array<{ id: string; userRating?: null | number }>,
itemIdSet,
(item) => createRatingUpdater(item),
);
return updatedData ? { ...prev, data: updatedData } : prev;
}
return itemIdSet.has(item.id)
? { ...item, userRating: rating }
: item;
}),
};
}
return prev;
},
);
}
});
}
});
break;
}
case LibraryItem.ALBUM_ARTIST: {
const detailQueryKey = queryKeys.albumArtists.detail(variables.apiClientProps.serverId);
const detailQueries = queryClient.getQueriesData({
exact: false,
queryKey: detailQueryKey,
});
if (detailQueries.length) {
detailQueries.forEach(([queryKey, data]) => {
if (data) {
previousQueries.push({ data, queryKey });
queryClient.setQueryData(
pendingUpdates.push({
previousData: data,
queryKey,
(prev: AlbumArtistDetailResponse | undefined) => {
if (!prev) {
return prev;
}
updater: (prev: AlbumArtistDetailResponse | undefined) => {
if (!prev) return prev;
// Update the main artist if it matches
if (itemIdSet.has(prev.id)) {
return { ...prev, userRating: rating };
}
// Update similar artists if any match
if (prev.similarArtists && prev.similarArtists.length > 0) {
const hasMatchingSimilarArtist = prev.similarArtists.some(
(artist) => itemIdSet.has(artist.id),
@@ -214,35 +248,31 @@ export const applyRatingOptimisticUpdates = (
return prev;
},
);
}
});
}
});
const listQueryKey = queryKeys.albumArtists.list(variables.apiClientProps.serverId);
const listQueries = queryClient.getQueriesData({
exact: false,
queryKey: listQueryKey,
});
if (listQueries.length) {
listQueries.forEach(([queryKey, data]) => {
if (data) {
previousQueries.push({ data, queryKey });
queryClient.setQueryData(queryKey, (prev: AlbumArtistListResponse) => {
return {
...prev,
items: prev.items.map((item: AlbumArtist) => {
return itemIdSet.has(item.id)
? { ...item, userRating: rating }
: item;
}),
};
pendingUpdates.push({
previousData: data,
queryKey,
updater: (prev: AlbumArtistListResponse | undefined) => {
if (!prev) return prev;
const updatedItems = updateItemInArray(prev.items, itemIdSet, (item) =>
createRatingUpdater<AlbumArtist>(item),
);
return updatedItems ? { ...prev, items: updatedItems } : prev;
},
});
}
});
}
const infiniteListQueryKey = queryKeys.albumArtists.infiniteList(
variables.apiClientProps.serverId,
@@ -252,31 +282,30 @@ export const applyRatingOptimisticUpdates = (
queryKey: infiniteListQueryKey,
});
if (infiniteListQueries.length) {
infiniteListQueries.forEach(([queryKey, data]) => {
if (data) {
previousQueries.push({ data, queryKey });
queryClient.setQueryData(
pendingUpdates.push({
previousData: data,
queryKey,
(prev: { pageParams: string[]; pages: AlbumArtistListResponse[] }) => {
return {
...prev,
pages: prev.pages.map((page: AlbumArtistListResponse) => {
return {
...page,
items: page.items.map((item: AlbumArtist) => {
return itemIdSet.has(item.id)
? { ...item, userRating: rating }
: item;
}),
};
}),
};
},
updater: (
prev:
| undefined
| { pageParams: string[]; pages: AlbumArtistListResponse[] },
) => {
if (!prev) return prev;
const updatedPages = updateItemsInPages<
AlbumArtist,
AlbumArtistListResponse
>(
prev.pages.filter((p): p is AlbumArtistListResponse => !!p),
itemIdSet,
(item) => createRatingUpdater<AlbumArtist>(item),
);
}
return updatedPages ? { ...prev, pages: updatedPages } : prev;
},
});
}
});
// Update infinite loader custom query keys
const infiniteLoaderQueryKey = [
@@ -290,13 +319,12 @@ export const applyRatingOptimisticUpdates = (
queryKey: infiniteLoaderQueryKey,
});
if (infiniteLoaderQueries.length) {
infiniteLoaderQueries.forEach(([queryKey, data]) => {
if (data) {
previousQueries.push({ data, queryKey });
queryClient.setQueryData(
pendingUpdates.push({
previousData: data,
queryKey,
(
updater: (
prev:
| undefined
| {
@@ -305,54 +333,43 @@ export const applyRatingOptimisticUpdates = (
},
) => {
if (prev && prev.data) {
return {
...prev,
data: prev.data.map((item: any) => {
if (!item || !item.id) {
return item;
const updatedData = updateItemInArray(
prev.data as Array<{ id: string; userRating?: null | number }>,
itemIdSet,
(item) => createRatingUpdater(item),
);
return updatedData ? { ...prev, data: updatedData } : prev;
}
return itemIdSet.has(item.id)
? { ...item, userRating: rating }
: item;
}),
};
}
return prev;
},
);
}
});
}
});
break;
}
case LibraryItem.ARTIST: {
const listQueryKey = queryKeys.artists.list(variables.apiClientProps.serverId);
const listQueries = queryClient.getQueriesData({
exact: false,
queryKey: listQueryKey,
});
if (listQueries.length) {
listQueries.forEach(([queryKey, data]) => {
if (data) {
previousQueries.push({ data, queryKey });
queryClient.setQueryData(queryKey, (prev: ArtistListResponse) => {
return {
...prev,
items: prev.items.map((item: AlbumArtist) => {
return itemIdSet.has(item.id)
? { ...item, userRating: rating }
: item;
}),
};
pendingUpdates.push({
previousData: data,
queryKey,
updater: (prev: ArtistListResponse | undefined) => {
if (!prev) return prev;
const updatedItems = updateItemInArray(prev.items, itemIdSet, (item) =>
createRatingUpdater<AlbumArtist>(item),
);
return updatedItems ? { ...prev, items: updatedItems } : prev;
},
});
}
});
}
const infiniteListQueryKey = queryKeys.artists.infiniteList(
variables.apiClientProps.serverId,
@@ -362,31 +379,28 @@ export const applyRatingOptimisticUpdates = (
queryKey: infiniteListQueryKey,
});
if (infiniteListQueries.length) {
infiniteListQueries.forEach(([queryKey, data]) => {
if (data) {
previousQueries.push({ data, queryKey });
queryClient.setQueryData(
pendingUpdates.push({
previousData: data,
queryKey,
(prev: { pageParams: string[]; pages: ArtistListResponse[] }) => {
return {
...prev,
pages: prev.pages.map((page: ArtistListResponse) => {
return {
...page,
items: page.items.map((item: AlbumArtist) => {
return itemIdSet.has(item.id)
? { ...item, userRating: rating }
: item;
}),
};
}),
};
},
updater: (
prev: undefined | { pageParams: string[]; pages: ArtistListResponse[] },
) => {
if (!prev) return prev;
const updatedPages = updateItemsInPages<
AlbumArtist,
AlbumArtistListResponse
>(
prev.pages.filter((p): p is AlbumArtistListResponse => !!p),
itemIdSet,
(item) => createRatingUpdater<AlbumArtist>(item),
);
}
return updatedPages ? { ...prev, pages: updatedPages } : prev;
},
});
}
});
// Update infinite loader custom query keys
const infiniteLoaderQueryKey = [
@@ -400,13 +414,12 @@ export const applyRatingOptimisticUpdates = (
queryKey: infiniteLoaderQueryKey,
});
if (infiniteLoaderQueries.length) {
infiniteLoaderQueries.forEach(([queryKey, data]) => {
if (data) {
previousQueries.push({ data, queryKey });
queryClient.setQueryData(
pendingUpdates.push({
previousData: data,
queryKey,
(
updater: (
prev:
| undefined
| {
@@ -415,26 +428,18 @@ export const applyRatingOptimisticUpdates = (
},
) => {
if (prev && prev.data) {
return {
...prev,
data: prev.data.map((item: any) => {
if (!item || !item.id) {
return item;
const updatedData = updateItemInArray(
prev.data as Array<{ id: string; userRating?: null | number }>,
itemIdSet,
(item) => createRatingUpdater(item),
);
return updatedData ? { ...prev, data: updatedData } : prev;
}
return itemIdSet.has(item.id)
? { ...item, userRating: rating }
: item;
}),
};
}
return prev;
},
);
}
});
}
});
break;
}
@@ -442,97 +447,256 @@ export const applyRatingOptimisticUpdates = (
case LibraryItem.QUEUE_SONG:
case LibraryItem.SONG: {
const albumDetailQueryKey = queryKeys.albums.detail(variables.apiClientProps.serverId);
const albumDetailQueries = queryClient.getQueriesData({
exact: false,
queryKey: albumDetailQueryKey,
});
if (albumDetailQueries.length) {
albumDetailQueries.forEach(([queryKey, data]) => {
if (data) {
previousQueries.push({ data, queryKey });
queryClient.setQueryData(
pendingUpdates.push({
previousData: data,
queryKey,
(prev: AlbumDetailResponse | undefined) => {
if (prev) {
return {
...prev,
songs: prev.songs?.map((song: Song) => {
return itemIdSet.has(song.id)
? { ...song, userRating: rating }
: song;
}),
};
}
return prev;
},
updater: (prev: AlbumDetailResponse | undefined) => {
if (!prev || !prev.songs) return prev;
const updatedSongs = updateItemInArray(prev.songs, itemIdSet, (item) =>
createRatingUpdater<Song>(item),
);
}
return updatedSongs ? { ...prev, songs: updatedSongs } : prev;
},
});
}
});
const detailQueryKey = queryKeys.songs.detail(variables.apiClientProps.serverId);
const detailQueries = queryClient.getQueriesData({
exact: false,
queryKey: detailQueryKey,
});
if (detailQueries.length) {
detailQueries.forEach(([queryKey, data]) => {
if (data) {
previousQueries.push({ data, queryKey });
queryClient.setQueryData(
pendingUpdates.push({
previousData: data,
queryKey,
(prev: SongDetailResponse | undefined) => {
updater: (prev: SongDetailResponse | undefined) => {
if (prev && itemIdSet.has(prev.id)) {
return { ...prev, userRating: rating };
}
return prev;
},
);
}
});
}
});
const topSongsQueryKey = queryKeys.albumArtists.topSongs(
variables.apiClientProps.serverId,
);
const topSongsQueries = queryClient.getQueriesData({
exact: false,
queryKey: topSongsQueryKey,
});
if (topSongsQueries.length) {
topSongsQueries.forEach(([queryKey, data]) => {
if (data) {
previousQueries.push({ data, queryKey });
queryClient.setQueryData(
pendingUpdates.push({
previousData: data,
queryKey,
(prev: TopSongListResponse | undefined) => {
if (prev) {
return {
...prev,
items: prev.items.map((item: Song) =>
itemIdSet.has(item.id)
? { ...item, userRating: rating }
: item,
),
};
}
return prev;
},
updater: (prev: TopSongListResponse | undefined) => {
if (!prev) return prev;
const updatedItems = updateItemInArray(prev.items, itemIdSet, (item) =>
createRatingUpdater<Song>(item),
);
}
return updatedItems ? { ...prev, items: updatedItems } : prev;
},
});
}
});
break;
}
}
return collectAndApplyUpdates(queryClient, pendingUpdates);
};
export const applyRatingOptimisticUpdatesDeferred = (
queryClient: QueryClient,
variables: SetRatingArgs,
rating: number,
): PreviousQueryData[] => {
const previousQueries: PreviousQueryData[] = [];
const itemIdSet = new Set<string>();
if (Array.isArray(variables.query.id)) {
variables.query.id.forEach((id) => {
itemIdSet.add(id);
});
} else {
itemIdSet.add(variables.query.id);
}
const queryKeysToUpdate: Array<{
data: unknown;
queryKey: readonly unknown[];
type: string;
}> = [];
const collectQueries = (baseKey: readonly unknown[], type: string) => {
const queries = queryClient.getQueriesData({ exact: false, queryKey: baseKey });
queries.forEach(([queryKey, data]) => {
if (data) {
previousQueries.push({ data, queryKey });
queryKeysToUpdate.push({ data, queryKey, type });
}
});
};
switch (variables.query.type) {
case LibraryItem.ALBUM: {
collectQueries(
queryKeys.albums.detail(variables.apiClientProps.serverId),
'album-detail',
);
collectQueries(queryKeys.albums.list(variables.apiClientProps.serverId), 'album-list');
collectQueries(
queryKeys.albums.infiniteList(variables.apiClientProps.serverId),
'album-infinite-list',
);
collectQueries(
[variables.apiClientProps.serverId, 'item-list-infinite-loader', LibraryItem.ALBUM],
'album-infinite-loader',
);
break;
}
case LibraryItem.ALBUM_ARTIST: {
collectQueries(
queryKeys.albumArtists.detail(variables.apiClientProps.serverId),
'album-artist-detail',
);
collectQueries(
queryKeys.albumArtists.list(variables.apiClientProps.serverId),
'album-artist-list',
);
collectQueries(
queryKeys.albumArtists.infiniteList(variables.apiClientProps.serverId),
'album-artist-infinite-list',
);
collectQueries(
[
variables.apiClientProps.serverId,
'item-list-infinite-loader',
LibraryItem.ALBUM_ARTIST,
],
'album-artist-infinite-loader',
);
break;
}
case LibraryItem.ARTIST: {
collectQueries(
queryKeys.artists.list(variables.apiClientProps.serverId),
'artist-list',
);
collectQueries(
queryKeys.artists.infiniteList(variables.apiClientProps.serverId),
'artist-infinite-list',
);
collectQueries(
[
variables.apiClientProps.serverId,
'item-list-infinite-loader',
LibraryItem.ARTIST,
],
'artist-infinite-loader',
);
break;
}
case LibraryItem.PLAYLIST_SONG:
case LibraryItem.QUEUE_SONG:
case LibraryItem.SONG: {
collectQueries(
queryKeys.albums.detail(variables.apiClientProps.serverId),
'album-detail',
);
collectQueries(
queryKeys.songs.detail(variables.apiClientProps.serverId),
'song-detail',
);
collectQueries(
queryKeys.albumArtists.topSongs(variables.apiClientProps.serverId),
'top-songs',
);
break;
}
}
queueMicrotask(() => {
queryKeysToUpdate.forEach(({ queryKey, type }) => {
queryClient.setQueryData(queryKey, (prev: any) => {
if (!prev) return prev;
switch (type) {
case 'album-artist-detail':
case 'album-detail':
case 'song-detail': {
if (itemIdSet.has(prev.id)) {
return { ...prev, userRating: rating };
}
if (prev.similarArtists) {
const hasMatch = prev.similarArtists.some((a: any) =>
itemIdSet.has(a.id),
);
if (hasMatch) {
return {
...prev,
similarArtists: prev.similarArtists.map((a: any) =>
itemIdSet.has(a.id) ? { ...a, userRating: rating } : a,
),
};
}
}
return prev;
}
case 'album-artist-infinite-list':
case 'album-infinite-list':
case 'artist-infinite-list': {
const updatedPages = updateItemsInPages(
prev.pages || [],
itemIdSet,
(item) => ({ ...item, userRating: rating }),
);
return updatedPages ? { ...prev, pages: updatedPages } : prev;
}
case 'album-artist-infinite-loader':
case 'album-infinite-loader':
case 'artist-infinite-loader': {
if (prev.data) {
const updatedData = updateItemInArray(prev.data, itemIdSet, (item) => ({
...item,
userRating: rating,
}));
return updatedData ? { ...prev, data: updatedData } : prev;
}
return prev;
}
case 'album-artist-list':
case 'album-list':
case 'artist-list':
case 'top-songs': {
const updatedItems = updateItemInArray(
prev.items || [],
itemIdSet,
(item) => ({ ...item, userRating: rating }),
);
return updatedItems ? { ...prev, items: updatedItems } : prev;
}
default:
return prev;
}
});
});
});
return previousQueries;
};