Skip to content

Use prime functions for entity updates#12421

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dylanjeffers merged 1 commit into from
Jun 26, 2025
Merged

Use prime functions for entity updates #12421

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions packages/common/src/api/tan-query/collection/useUpdateCollection.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -179,10 +179,11 @@ export const useUpdateCollection = () => {
onError: (_err, { collectionId }, context?: MutationContext) => {
// If the mutation fails, roll back collection data
if (context?.previousCollection) {
queryClient.setQueryData(
getCollectionQueryKey(collectionId),
context.previousCollection
)
primeCollectionData({
collections: [context.previousCollection],
queryClient,
forceReplace: true
})
}
},
onSettled: (_, __, { collectionId }) => {
Expand Down
6 changes: 5 additions & 1 deletion packages/common/src/api/tan-query/tracks/useFavoriteTrack.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -155,7 +155,11 @@ export const useFavoriteTrack = () => {
if (!context) return

// Revert optimistic updates
queryClient.setQueryData(getTrackQueryKey(trackId), context.previousTrack)
primeTrackData({
tracks: [context.previousTrack],
queryClient,
forceReplace: true
})
dispatch(accountActions.decrementTrackSaveCount())

reportToSentry({
Expand Down
6 changes: 5 additions & 1 deletion packages/common/src/api/tan-query/tracks/useUnfavoriteTrack.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -126,7 +126,11 @@ export const useUnfavoriteTrack = () => {
if (!context) return

// Revert optimistic updates
queryClient.setQueryData(getTrackQueryKey(trackId), context.previousTrack)
primeTrackData({
tracks: [context.previousTrack],
queryClient,
forceReplace: true
})
dispatch(accountActions.incrementTrackSaveCount())

reportToSentry({
Expand Down
9 changes: 5 additions & 4 deletions packages/common/src/api/tan-query/tracks/useUpdateTrack.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -111,10 +111,11 @@ export const useUpdateTrack = () => {
) => {
// If the mutation fails, roll back track data
if (context?.previousTrack) {
queryClient.setQueryData(
getTrackQueryKey(trackId),
context.previousTrack
)
primeTrackData({
tracks: [context.previousTrack],
queryClient,
forceReplace: true
})
}

// Roll back all collections that contain this track
Expand Down
26 changes: 18 additions & 8 deletions packages/common/src/api/tan-query/users/useFollowUser.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,12 +5,12 @@ import { useDispatch } from 'react-redux'

import { useQueryContext } from '~/api/tan-query/utils'
import { useAppContext } from '~/context/appContext'
import { Kind } from '~/models'
import { Name, FollowSource } from '~/models/Analytics'
import { Feature } from '~/models/ErrorReporting'
import { ID } from '~/models/Identifiers'
import { UserMetadata } from '~/models/User'
import { update } from '~/store/cache/actions'

import { primeUserData } from '../utils/primeUserData'

import { useCurrentUserId } from './account/useCurrentUserId'
import { getUserQueryKey } from './useUser'
Expand DownExpand Up@@ -91,19 +91,25 @@ export const useFollowUser = () => {
...previousUser,
...followeeUpdate
}
queryClient.setQueryData(getUserQueryKey(followeeUserId), updatedUser)
primeUserData({
users: [updatedUser],
queryClient,
forceReplace: true
})
}
dispatch(
update(Kind.USERS, [{ id: followeeUserId, metadata: followeeUpdate }])
)

const currentUser = queryClient.getQueryData(
getUserQueryKey(currentUserId)
)
if (currentUser) {
queryClient.setQueryData(getUserQueryKey(currentUserId), {
const updatedCurrentUser = {
...currentUser,
followee_count: (currentUser?.followee_count ?? 0) + 1
}
primeUserData({
users: [updatedCurrentUser],
queryClient,
forceReplace: true
})
}

Expand All@@ -117,7 +123,11 @@ export const useFollowUser = () => {
const { previousUser } = context ?? {}

if (previousUser) {
queryClient.setQueryData(getUserQueryKey(followeeUserId), previousUser)
primeUserData({
users: [previousUser],
queryClient,
forceReplace: true
})
}

reportToSentry({
Expand Down
24 changes: 18 additions & 6 deletions packages/common/src/api/tan-query/users/useUnfollowUser.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,15 +4,15 @@ import { useDispatch } from 'react-redux'

import { useQueryContext } from '~/api/tan-query/utils/QueryContext'
import { useAppContext } from '~/context/appContext'
import { Kind } from '~/models'
import { Name, FollowSource } from '~/models/Analytics'
import { Feature } from '~/models/ErrorReporting'
import { ID } from '~/models/Identifiers'
import { UserMetadata } from '~/models/User'
import { update } from '~/store/cache/actions'
import { removeFolloweeId } from '~/store/gated-content/slice'
import { revokeFollowGatedAccess } from '~/store/tipping/slice'

import { primeUserData } from '../utils/primeUserData'

import { useCurrentUserId } from './account/useCurrentUserId'
import { getUserQueryKey } from './useUser'

Expand DownExpand Up@@ -84,17 +84,25 @@ export const useUnfollowUser = () => {
...previousUser,
...followeeUpdate
}
queryClient.setQueryData(getUserQueryKey(followeeUserId), updatedUser)
primeUserData({
users: [updatedUser],
queryClient,
forceReplace: true
})
}
dispatch(update(Kind.USERS, [{ id: followeeUserId, metadata: update }]))

const currentUser = queryClient.getQueryData(
getUserQueryKey(currentUserId)
)
if (currentUser) {
queryClient.setQueryData(getUserQueryKey(currentUserId), {
const updatedCurrentUser = {
...currentUser,
followee_count: Math.max((currentUser?.followee_count ?? 0) - 1, 0)
}
primeUserData({
users: [updatedCurrentUser],
queryClient,
forceReplace: true
})
}

Expand All@@ -108,7 +116,11 @@ export const useUnfollowUser = () => {
const { previousUser } = context ?? {}

if (previousUser) {
queryClient.setQueryData(getUserQueryKey(followeeUserId), previousUser)
primeUserData({
users: [previousUser],
queryClient,
forceReplace: true
})
}

reportToSentry({
Expand Down
23 changes: 18 additions & 5 deletions packages/common/src/api/tan-query/users/useUpdateUser.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,8 @@ import { ID } from '~/models/Identifiers'
import { PlaylistLibrary } from '~/models/PlaylistLibrary'
import { UserMetadata } from '~/models/User'

import { primeUserData } from '../utils/primeUserData'

import { getUserQueryKey } from './useUser'

type MutationContext = {
Expand DownExpand Up@@ -49,18 +51,29 @@ export const useUpdateUser = () => {
const previousUser = queryClient.getQueryData(getUserQueryKey(userId))

// Optimistically update user
queryClient.setQueryData(getUserQueryKey(userId), (old: any) => ({
...old,
...metadata
}))
if (previousUser) {
const updatedUser = {
...previousUser,
...metadata
}
primeUserData({
users: [updatedUser],
queryClient,
forceReplace: true
})
}

// Return context with the previous user
return { previousUser }
},
onError: (_err, { userId }, context?: MutationContext) => {
// If the mutation fails, roll back user data
if (context?.previousUser) {
queryClient.setQueryData(getUserQueryKey(userId), context.previousUser)
primeUserData({
users: [context.previousUser],
queryClient,
forceReplace: true
})
}
},
onSettled: (_, __) => {
Expand Down
29 changes: 23 additions & 6 deletions packages/common/src/api/tan-query/utils/updateCollectionData.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,20 +7,37 @@ import { mergeCustomizer } from '~/store/cache/mergeCustomizer'

import { getCollectionQueryKey } from '../collection/useCollection'

import { primeCollectionData } from './primeCollectionData'

type PartialCollectionUpdate = Partial<Collection> & { playlist_id: ID }

export const updateCollectionData = function* (
partialCollections: PartialCollectionUpdate[]
) {
const queryClient = yield* getContext<QueryClient>('queryClient')

partialCollections.forEach((partialCollection) => {
// Get existing collection data and merge with updates
const collectionsToUpdate = partialCollections.map((partialCollection) => {
const { playlist_id } = partialCollection
const existingCollection = queryClient.getQueryData(
getCollectionQueryKey(playlist_id)
) as Collection | undefined

if (existingCollection) {
return mergeWith(
{},
existingCollection,
partialCollection,
mergeCustomizer
)
}
return partialCollection as Collection
})

queryClient.setQueryData(
getCollectionQueryKey(playlist_id),
// TODO: drop the merge customizer once we're fully off of redux
(prev) => prev && mergeWith({}, prev, partialCollection, mergeCustomizer)
)
// Use primeCollectionData with forceReplace to ensure updates are saved
primeCollectionData({
collections: collectionsToUpdate,
queryClient,
forceReplace: true
})
}
25 changes: 18 additions & 7 deletions packages/common/src/api/tan-query/utils/updateTrackData.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,8 @@ import { mergeCustomizer } from '~/store/cache/mergeCustomizer'

import { getTrackQueryKey } from '../tracks/useTrack'

import { primeTrackData } from './primeTrackData'

type PartialTrackUpdate = Partial<Track> & { track_id: ID }

/**
Expand All@@ -27,14 +29,23 @@ type PartialTrackUpdate = Partial<Track> & { track_id: ID }
export const updateTrackData = function* (partialTracks: PartialTrackUpdate[]) {
const queryClient = yield* getContext<QueryClient>('queryClient')

partialTracks.forEach((partialTrack) => {
// Get existing track data and merge with updates
const tracksToUpdate = partialTracks.map((partialTrack) => {
const { track_id } = partialTrack
const existingTrack = queryClient.getQueryData(
getTrackQueryKey(track_id)
) as Track | undefined

if (existingTrack) {
return mergeWith({}, existingTrack, partialTrack, mergeCustomizer)
}
return partialTrack as Track
})

// Update react-query store
queryClient.setQueryData(
getTrackQueryKey(track_id),
// TODO: drop the merge customizer once we're fully off of redux
(prev) => prev && mergeWith({}, prev, partialTrack, mergeCustomizer)
)
// Use primeTrackData with forceReplace to ensure updates are saved
primeTrackData({
tracks: tracksToUpdate,
queryClient,
forceReplace: true
})
}
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Use prime functions for entity updates by dylanjeffers · Pull Request #12421 · AudiusProject/apps · GitHub
Skip to content
Use prime functions for entity updates#12421

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

dylanjeffers
merged 1 commit into

from

Jun 26, 2025
 Merged


Use prime functions for entity updates
#12421
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


9 changes: 5 additions & 4 deletions
packages/common/src/api/tan-query/collection/useUpdateCollection.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -179,10 +179,11 @@ export const useUpdateCollection = () => {
 onError: (_err, { collectionId }, context?: MutationContext) => {
 // If the mutation fails, roll back collection data
 if (context?.previousCollection) {
 queryClient.setQueryData(
 getCollectionQueryKey(collectionId),
 context.previousCollection
 )
 primeCollectionData({
 collections: [context.previousCollection],
 queryClient,
 forceReplace: true
 })
 }
 },
 onSettled: (_, __, { collectionId }) => {
Expand Down

6 changes: 5 additions & 1 deletion
packages/common/src/api/tan-query/tracks/useFavoriteTrack.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -155,7 +155,11 @@ export const useFavoriteTrack = () => {
 if (!context) return

 // Revert optimistic updates
 queryClient.setQueryData(getTrackQueryKey(trackId), context.previousTrack)
 primeTrackData({
 tracks: [context.previousTrack],
 queryClient,
 forceReplace: true
 })
 dispatch(accountActions.decrementTrackSaveCount())

 reportToSentry({
Expand Down

6 changes: 5 additions & 1 deletion
packages/common/src/api/tan-query/tracks/useUnfavoriteTrack.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -126,7 +126,11 @@ export const useUnfavoriteTrack = () => {
 if (!context) return

 // Revert optimistic updates
 queryClient.setQueryData(getTrackQueryKey(trackId), context.previousTrack)
 primeTrackData({
 tracks: [context.previousTrack],
 queryClient,
 forceReplace: true
 })
 dispatch(accountActions.incrementTrackSaveCount())

 reportToSentry({
Expand Down

9 changes: 5 additions & 4 deletions
packages/common/src/api/tan-query/tracks/useUpdateTrack.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,10 +111,11 @@ export const useUpdateTrack = () => {
 ) => {
 // If the mutation fails, roll back track data
 if (context?.previousTrack) {
 queryClient.setQueryData(
 getTrackQueryKey(trackId),
 context.previousTrack
 )
 primeTrackData({
 tracks: [context.previousTrack],
 queryClient,
 forceReplace: true
 })
 }

 // Roll back all collections that contain this track
Expand Down

26 changes: 18 additions & 8 deletions
packages/common/src/api/tan-query/users/useFollowUser.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,12 +5,12 @@ import { useDispatch } from 'react-redux'

import { useQueryContext } from '~/api/tan-query/utils'
import { useAppContext } from '~/context/appContext'
import { Kind } from '~/models'
import { Name, FollowSource } from '~/models/Analytics'
import { Feature } from '~/models/ErrorReporting'
import { ID } from '~/models/Identifiers'
import { UserMetadata } from '~/models/User'
import { update } from '~/store/cache/actions'

import { primeUserData } from '../utils/primeUserData'

import { useCurrentUserId } from './account/useCurrentUserId'
import { getUserQueryKey } from './useUser'
Expand DownExpand Up@@ -91,19 +91,25 @@ export const useFollowUser = () => {
 ...previousUser,
 ...followeeUpdate
 }
 queryClient.setQueryData(getUserQueryKey(followeeUserId), updatedUser)
 primeUserData({
 users: [updatedUser],
 queryClient,
 forceReplace: true
 })
 }
 dispatch(
 update(Kind.USERS, [{ id: followeeUserId, metadata: followeeUpdate }])
 )

 const currentUser = queryClient.getQueryData(
 getUserQueryKey(currentUserId)
 )
 if (currentUser) {
queryClient.setQueryData(getUserQueryKey(currentUserId), {
const updatedCurrentUser = {
 ...currentUser,
 followee_count: (currentUser?.followee_count ?? 0) + 1
 }
 primeUserData({
 users: [updatedCurrentUser],
 queryClient,
 forceReplace: true
 })
 }

Expand All@@ -117,7 +123,11 @@ export const useFollowUser = () => {
 const { previousUser } = context ?? {}

 if (previousUser) {
 queryClient.setQueryData(getUserQueryKey(followeeUserId), previousUser)
 primeUserData({
 users: [previousUser],
 queryClient,
 forceReplace: true
 })
 }

 reportToSentry({
Expand Down

24 changes: 18 additions & 6 deletions
packages/common/src/api/tan-query/users/useUnfollowUser.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,15 +4,15 @@ import { useDispatch } from 'react-redux'

import { useQueryContext } from '~/api/tan-query/utils/QueryContext'
import { useAppContext } from '~/context/appContext'
import { Kind } from '~/models'
import { Name, FollowSource } from '~/models/Analytics'
import { Feature } from '~/models/ErrorReporting'
import { ID } from '~/models/Identifiers'
import { UserMetadata } from '~/models/User'
import { update } from '~/store/cache/actions'
import { removeFolloweeId } from '~/store/gated-content/slice'
import { revokeFollowGatedAccess } from '~/store/tipping/slice'

import { primeUserData } from '../utils/primeUserData'

import { useCurrentUserId } from './account/useCurrentUserId'
import { getUserQueryKey } from './useUser'

Expand DownExpand Up@@ -84,17 +84,25 @@ export const useUnfollowUser = () => {
 ...previousUser,
 ...followeeUpdate
 }
 queryClient.setQueryData(getUserQueryKey(followeeUserId), updatedUser)
 primeUserData({
 users: [updatedUser],
 queryClient,
 forceReplace: true
 })
 }
 dispatch(update(Kind.USERS, [{ id: followeeUserId, metadata: update }]))

 const currentUser = queryClient.getQueryData(
 getUserQueryKey(currentUserId)
 )
 if (currentUser) {
queryClient.setQueryData(getUserQueryKey(currentUserId), {
const updatedCurrentUser = {
 ...currentUser,
 followee_count: Math.max((currentUser?.followee_count ?? 0) - 1, 0)
 }
 primeUserData({
 users: [updatedCurrentUser],
 queryClient,
 forceReplace: true
 })
 }

Expand All@@ -108,7 +116,11 @@ export const useUnfollowUser = () => {
 const { previousUser } = context ?? {}

 if (previousUser) {
 queryClient.setQueryData(getUserQueryKey(followeeUserId), previousUser)
 primeUserData({
 users: [previousUser],
 queryClient,
 forceReplace: true
 })
 }

 reportToSentry({
Expand Down

23 changes: 18 additions & 5 deletions
packages/common/src/api/tan-query/users/useUpdateUser.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,8 @@ import { ID } from '~/models/Identifiers'
import { PlaylistLibrary } from '~/models/PlaylistLibrary'
import { UserMetadata } from '~/models/User'

import { primeUserData } from '../utils/primeUserData'

import { getUserQueryKey } from './useUser'

type MutationContext = {
Expand DownExpand Up@@ -49,18 +51,29 @@ export const useUpdateUser = () => {
 const previousUser = queryClient.getQueryData(getUserQueryKey(userId))

 // Optimistically update user
 queryClient.setQueryData(getUserQueryKey(userId), (old: any) => ({
 ...old,
 ...metadata
 }))
 if (previousUser) {
 const updatedUser = {
 ...previousUser,
 ...metadata
 }
 primeUserData({
 users: [updatedUser],
 queryClient,
 forceReplace: true
 })
 }

 // Return context with the previous user
 return { previousUser }
 },
 onError: (_err, { userId }, context?: MutationContext) => {
 // If the mutation fails, roll back user data
 if (context?.previousUser) {
 queryClient.setQueryData(getUserQueryKey(userId), context.previousUser)
 primeUserData({
 users: [context.previousUser],
 queryClient,
 forceReplace: true
 })
 }
 },
 onSettled: (_, __) => {
Expand Down

29 changes: 23 additions & 6 deletions
packages/common/src/api/tan-query/utils/updateCollectionData.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,20 +7,37 @@ import { mergeCustomizer } from '~/store/cache/mergeCustomizer'

import { getCollectionQueryKey } from '../collection/useCollection'

import { primeCollectionData } from './primeCollectionData'

type PartialCollectionUpdate = Partial<Collection> & { playlist_id: ID }

export const updateCollectionData = function* (
 partialCollections: PartialCollectionUpdate[]
) {
 const queryClient = yield* getContext<QueryClient>('queryClient')

 partialCollections.forEach((partialCollection) => {
 // Get existing collection data and merge with updates
 const collectionsToUpdate = partialCollections.map((partialCollection) => {
 const { playlist_id } = partialCollection
 const existingCollection = queryClient.getQueryData(
 getCollectionQueryKey(playlist_id)
 ) as Collection | undefined

 if (existingCollection) {
 return mergeWith(
 {},
 existingCollection,
 partialCollection,
 mergeCustomizer
 )
 }
 return partialCollection as Collection
 })

 queryClient.setQueryData(
 getCollectionQueryKey(playlist_id),
 // TODO: drop the merge customizer once we're fully off of redux
 (prev) => prev && mergeWith({}, prev, partialCollection, mergeCustomizer)
)
// Use primeCollectionData with forceReplace to ensure updates are saved
primeCollectionData({
collections: collectionsToUpdate,
queryClient,
forceReplace: true
 })
}

25 changes: 18 additions & 7 deletions
packages/common/src/api/tan-query/utils/updateTrackData.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,8 @@ import { mergeCustomizer } from '~/store/cache/mergeCustomizer'

import { getTrackQueryKey } from '../tracks/useTrack'

import { primeTrackData } from './primeTrackData'

type PartialTrackUpdate = Partial<Track> & { track_id: ID }

/**
Expand All@@ -27,14 +29,23 @@ type PartialTrackUpdate = Partial<Track> & { track_id: ID }
export const updateTrackData = function* (partialTracks: PartialTrackUpdate[]) {
 const queryClient = yield* getContext<QueryClient>('queryClient')

 partialTracks.forEach((partialTrack) => {
 // Get existing track data and merge with updates
 const tracksToUpdate = partialTracks.map((partialTrack) => {
 const { track_id } = partialTrack
 const existingTrack = queryClient.getQueryData(
 getTrackQueryKey(track_id)
 ) as Track | undefined

 if (existingTrack) {
 return mergeWith({}, existingTrack, partialTrack, mergeCustomizer)
 }
 return partialTrack as Track
 })

 // Update react-query store
 queryClient.setQueryData(
 getTrackQueryKey(track_id),
 // TODO: drop the merge customizer once we're fully off of redux
 (prev) => prev && mergeWith({}, prev, partialTrack, mergeCustomizer)
 )
 // Use primeTrackData with forceReplace to ensure updates are saved
 primeTrackData({
 tracks: tracksToUpdate,
 queryClient,
 forceReplace: true
 })
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Use prime functions for entity updates by dylanjeffers · Pull Request #12421 · AudiusProject/apps · GitHub
Skip to content
Use prime functions for entity updates#12421

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

dylanjeffers
merged 1 commit into

from

Jun 26, 2025
 Merged


Use prime functions for entity updates
#12421
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


9 changes: 5 additions & 4 deletions
packages/common/src/api/tan-query/collection/useUpdateCollection.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -179,10 +179,11 @@ export const useUpdateCollection = () => {
 onError: (_err, { collectionId }, context?: MutationContext) => {
 // If the mutation fails, roll back collection data
 if (context?.previousCollection) {
 queryClient.setQueryData(
 getCollectionQueryKey(collectionId),
 context.previousCollection
 )
 primeCollectionData({
 collections: [context.previousCollection],
 queryClient,
 forceReplace: true
 })
 }
 },
 onSettled: (_, __, { collectionId }) => {
Expand Down

6 changes: 5 additions & 1 deletion
packages/common/src/api/tan-query/tracks/useFavoriteTrack.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -155,7 +155,11 @@ export const useFavoriteTrack = () => {
 if (!context) return

 // Revert optimistic updates
 queryClient.setQueryData(getTrackQueryKey(trackId), context.previousTrack)
 primeTrackData({
 tracks: [context.previousTrack],
 queryClient,
 forceReplace: true
 })
 dispatch(accountActions.decrementTrackSaveCount())

 reportToSentry({
Expand Down

6 changes: 5 additions & 1 deletion
packages/common/src/api/tan-query/tracks/useUnfavoriteTrack.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -126,7 +126,11 @@ export const useUnfavoriteTrack = () => {
 if (!context) return

 // Revert optimistic updates
 queryClient.setQueryData(getTrackQueryKey(trackId), context.previousTrack)
 primeTrackData({
 tracks: [context.previousTrack],
 queryClient,
 forceReplace: true
 })
 dispatch(accountActions.incrementTrackSaveCount())

 reportToSentry({
Expand Down

9 changes: 5 additions & 4 deletions
packages/common/src/api/tan-query/tracks/useUpdateTrack.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,10 +111,11 @@ export const useUpdateTrack = () => {
 ) => {
 // If the mutation fails, roll back track data
 if (context?.previousTrack) {
 queryClient.setQueryData(
 getTrackQueryKey(trackId),
 context.previousTrack
 )
 primeTrackData({
 tracks: [context.previousTrack],
 queryClient,
 forceReplace: true
 })
 }

 // Roll back all collections that contain this track
Expand Down

26 changes: 18 additions & 8 deletions
packages/common/src/api/tan-query/users/useFollowUser.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,12 +5,12 @@ import { useDispatch } from 'react-redux'

import { useQueryContext } from '~/api/tan-query/utils'
import { useAppContext } from '~/context/appContext'
import { Kind } from '~/models'
import { Name, FollowSource } from '~/models/Analytics'
import { Feature } from '~/models/ErrorReporting'
import { ID } from '~/models/Identifiers'
import { UserMetadata } from '~/models/User'
import { update } from '~/store/cache/actions'

import { primeUserData } from '../utils/primeUserData'

import { useCurrentUserId } from './account/useCurrentUserId'
import { getUserQueryKey } from './useUser'
Expand DownExpand Up@@ -91,19 +91,25 @@ export const useFollowUser = () => {
 ...previousUser,
 ...followeeUpdate
 }
 queryClient.setQueryData(getUserQueryKey(followeeUserId), updatedUser)
 primeUserData({
 users: [updatedUser],
 queryClient,
 forceReplace: true
 })
 }
 dispatch(
 update(Kind.USERS, [{ id: followeeUserId, metadata: followeeUpdate }])
 )

 const currentUser = queryClient.getQueryData(
 getUserQueryKey(currentUserId)
 )
 if (currentUser) {
queryClient.setQueryData(getUserQueryKey(currentUserId), {
const updatedCurrentUser = {
 ...currentUser,
 followee_count: (currentUser?.followee_count ?? 0) + 1
 }
 primeUserData({
 users: [updatedCurrentUser],
 queryClient,
 forceReplace: true
 })
 }

Expand All@@ -117,7 +123,11 @@ export const useFollowUser = () => {
 const { previousUser } = context ?? {}

 if (previousUser) {
 queryClient.setQueryData(getUserQueryKey(followeeUserId), previousUser)
 primeUserData({
 users: [previousUser],
 queryClient,
 forceReplace: true
 })
 }

 reportToSentry({
Expand Down

24 changes: 18 additions & 6 deletions
packages/common/src/api/tan-query/users/useUnfollowUser.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,15 +4,15 @@ import { useDispatch } from 'react-redux'

import { useQueryContext } from '~/api/tan-query/utils/QueryContext'
import { useAppContext } from '~/context/appContext'
import { Kind } from '~/models'
import { Name, FollowSource } from '~/models/Analytics'
import { Feature } from '~/models/ErrorReporting'
import { ID } from '~/models/Identifiers'
import { UserMetadata } from '~/models/User'
import { update } from '~/store/cache/actions'
import { removeFolloweeId } from '~/store/gated-content/slice'
import { revokeFollowGatedAccess } from '~/store/tipping/slice'

import { primeUserData } from '../utils/primeUserData'

import { useCurrentUserId } from './account/useCurrentUserId'
import { getUserQueryKey } from './useUser'

Expand DownExpand Up@@ -84,17 +84,25 @@ export const useUnfollowUser = () => {
 ...previousUser,
 ...followeeUpdate
 }
 queryClient.setQueryData(getUserQueryKey(followeeUserId), updatedUser)
 primeUserData({
 users: [updatedUser],
 queryClient,
 forceReplace: true
 })
 }
 dispatch(update(Kind.USERS, [{ id: followeeUserId, metadata: update }]))

 const currentUser = queryClient.getQueryData(
 getUserQueryKey(currentUserId)
 )
 if (currentUser) {
queryClient.setQueryData(getUserQueryKey(currentUserId), {
const updatedCurrentUser = {
 ...currentUser,
 followee_count: Math.max((currentUser?.followee_count ?? 0) - 1, 0)
 }
 primeUserData({
 users: [updatedCurrentUser],
 queryClient,
 forceReplace: true
 })
 }

Expand All@@ -108,7 +116,11 @@ export const useUnfollowUser = () => {
 const { previousUser } = context ?? {}

 if (previousUser) {
 queryClient.setQueryData(getUserQueryKey(followeeUserId), previousUser)
 primeUserData({
 users: [previousUser],
 queryClient,
 forceReplace: true
 })
 }

 reportToSentry({
Expand Down

23 changes: 18 additions & 5 deletions
packages/common/src/api/tan-query/users/useUpdateUser.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,8 @@ import { ID } from '~/models/Identifiers'
import { PlaylistLibrary } from '~/models/PlaylistLibrary'
import { UserMetadata } from '~/models/User'

import { primeUserData } from '../utils/primeUserData'

import { getUserQueryKey } from './useUser'

type MutationContext = {
Expand DownExpand Up@@ -49,18 +51,29 @@ export const useUpdateUser = () => {
 const previousUser = queryClient.getQueryData(getUserQueryKey(userId))

 // Optimistically update user
 queryClient.setQueryData(getUserQueryKey(userId), (old: any) => ({
 ...old,
 ...metadata
 }))
 if (previousUser) {
 const updatedUser = {
 ...previousUser,
 ...metadata
 }
 primeUserData({
 users: [updatedUser],
 queryClient,
 forceReplace: true
 })
 }

 // Return context with the previous user
 return { previousUser }
 },
 onError: (_err, { userId }, context?: MutationContext) => {
 // If the mutation fails, roll back user data
 if (context?.previousUser) {
 queryClient.setQueryData(getUserQueryKey(userId), context.previousUser)
 primeUserData({
 users: [context.previousUser],
 queryClient,
 forceReplace: true
 })
 }
 },
 onSettled: (_, __) => {
Expand Down

29 changes: 23 additions & 6 deletions
packages/common/src/api/tan-query/utils/updateCollectionData.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,20 +7,37 @@ import { mergeCustomizer } from '~/store/cache/mergeCustomizer'

import { getCollectionQueryKey } from '../collection/useCollection'

import { primeCollectionData } from './primeCollectionData'

type PartialCollectionUpdate = Partial<Collection> & { playlist_id: ID }

export const updateCollectionData = function* (
 partialCollections: PartialCollectionUpdate[]
) {
 const queryClient = yield* getContext<QueryClient>('queryClient')

 partialCollections.forEach((partialCollection) => {
 // Get existing collection data and merge with updates
 const collectionsToUpdate = partialCollections.map((partialCollection) => {
 const { playlist_id } = partialCollection
 const existingCollection = queryClient.getQueryData(
 getCollectionQueryKey(playlist_id)
 ) as Collection | undefined

 if (existingCollection) {
 return mergeWith(
 {},
 existingCollection,
 partialCollection,
 mergeCustomizer
 )
 }
 return partialCollection as Collection
 })

 queryClient.setQueryData(
 getCollectionQueryKey(playlist_id),
 // TODO: drop the merge customizer once we're fully off of redux
 (prev) => prev && mergeWith({}, prev, partialCollection, mergeCustomizer)
)
// Use primeCollectionData with forceReplace to ensure updates are saved
primeCollectionData({
collections: collectionsToUpdate,
queryClient,
forceReplace: true
 })
}

25 changes: 18 additions & 7 deletions
packages/common/src/api/tan-query/utils/updateTrackData.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,8 @@ import { mergeCustomizer } from '~/store/cache/mergeCustomizer'

import { getTrackQueryKey } from '../tracks/useTrack'

import { primeTrackData } from './primeTrackData'

type PartialTrackUpdate = Partial<Track> & { track_id: ID }

/**
Expand All@@ -27,14 +29,23 @@ type PartialTrackUpdate = Partial<Track> & { track_id: ID }
export const updateTrackData = function* (partialTracks: PartialTrackUpdate[]) {
 const queryClient = yield* getContext<QueryClient>('queryClient')

 partialTracks.forEach((partialTrack) => {
 // Get existing track data and merge with updates
 const tracksToUpdate = partialTracks.map((partialTrack) => {
 const { track_id } = partialTrack
 const existingTrack = queryClient.getQueryData(
 getTrackQueryKey(track_id)
 ) as Track | undefined

 if (existingTrack) {
 return mergeWith({}, existingTrack, partialTrack, mergeCustomizer)
 }
 return partialTrack as Track
 })

 // Update react-query store
 queryClient.setQueryData(
 getTrackQueryKey(track_id),
 // TODO: drop the merge customizer once we're fully off of redux
 (prev) => prev && mergeWith({}, prev, partialTrack, mergeCustomizer)
 )
 // Use primeTrackData with forceReplace to ensure updates are saved
 primeTrackData({
 tracks: tracksToUpdate,
 queryClient,
 forceReplace: true
 })
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Use prime functions for entity updates by dylanjeffers · Pull Request #12421 · AudiusProject/apps · GitHub
Skip to content
Use prime functions for entity updates#12421

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

dylanjeffers
merged 1 commit into

from

Jun 26, 2025
 Merged


Use prime functions for entity updates
#12421
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


9 changes: 5 additions & 4 deletions
packages/common/src/api/tan-query/collection/useUpdateCollection.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -179,10 +179,11 @@ export const useUpdateCollection = () => {
 onError: (_err, { collectionId }, context?: MutationContext) => {
 // If the mutation fails, roll back collection data
 if (context?.previousCollection) {
 queryClient.setQueryData(
 getCollectionQueryKey(collectionId),
 context.previousCollection
 )
 primeCollectionData({
 collections: [context.previousCollection],
 queryClient,
 forceReplace: true
 })
 }
 },
 onSettled: (_, __, { collectionId }) => {
Expand Down

6 changes: 5 additions & 1 deletion
packages/common/src/api/tan-query/tracks/useFavoriteTrack.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -155,7 +155,11 @@ export const useFavoriteTrack = () => {
 if (!context) return

 // Revert optimistic updates
 queryClient.setQueryData(getTrackQueryKey(trackId), context.previousTrack)
 primeTrackData({
 tracks: [context.previousTrack],
 queryClient,
 forceReplace: true
 })
 dispatch(accountActions.decrementTrackSaveCount())

 reportToSentry({
Expand Down

6 changes: 5 additions & 1 deletion
packages/common/src/api/tan-query/tracks/useUnfavoriteTrack.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -126,7 +126,11 @@ export const useUnfavoriteTrack = () => {
 if (!context) return

 // Revert optimistic updates
 queryClient.setQueryData(getTrackQueryKey(trackId), context.previousTrack)
 primeTrackData({
 tracks: [context.previousTrack],
 queryClient,
 forceReplace: true
 })
 dispatch(accountActions.incrementTrackSaveCount())

 reportToSentry({
Expand Down

9 changes: 5 additions & 4 deletions
packages/common/src/api/tan-query/tracks/useUpdateTrack.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,10 +111,11 @@ export const useUpdateTrack = () => {
 ) => {
 // If the mutation fails, roll back track data
 if (context?.previousTrack) {
 queryClient.setQueryData(
 getTrackQueryKey(trackId),
 context.previousTrack
 )
 primeTrackData({
 tracks: [context.previousTrack],
 queryClient,
 forceReplace: true
 })
 }

 // Roll back all collections that contain this track
Expand Down

26 changes: 18 additions & 8 deletions
packages/common/src/api/tan-query/users/useFollowUser.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,12 +5,12 @@ import { useDispatch } from 'react-redux'

import { useQueryContext } from '~/api/tan-query/utils'
import { useAppContext } from '~/context/appContext'
import { Kind } from '~/models'
import { Name, FollowSource } from '~/models/Analytics'
import { Feature } from '~/models/ErrorReporting'
import { ID } from '~/models/Identifiers'
import { UserMetadata } from '~/models/User'
import { update } from '~/store/cache/actions'

import { primeUserData } from '../utils/primeUserData'

import { useCurrentUserId } from './account/useCurrentUserId'
import { getUserQueryKey } from './useUser'
Expand DownExpand Up@@ -91,19 +91,25 @@ export const useFollowUser = () => {
 ...previousUser,
 ...followeeUpdate
 }
 queryClient.setQueryData(getUserQueryKey(followeeUserId), updatedUser)
 primeUserData({
 users: [updatedUser],
 queryClient,
 forceReplace: true
 })
 }
 dispatch(
 update(Kind.USERS, [{ id: followeeUserId, metadata: followeeUpdate }])
 )

 const currentUser = queryClient.getQueryData(
 getUserQueryKey(currentUserId)
 )
 if (currentUser) {
queryClient.setQueryData(getUserQueryKey(currentUserId), {
const updatedCurrentUser = {
 ...currentUser,
 followee_count: (currentUser?.followee_count ?? 0) + 1
 }
 primeUserData({
 users: [updatedCurrentUser],
 queryClient,
 forceReplace: true
 })
 }

Expand All@@ -117,7 +123,11 @@ export const useFollowUser = () => {
 const { previousUser } = context ?? {}

 if (previousUser) {
 queryClient.setQueryData(getUserQueryKey(followeeUserId), previousUser)
 primeUserData({
 users: [previousUser],
 queryClient,
 forceReplace: true
 })
 }

 reportToSentry({
Expand Down

24 changes: 18 additions & 6 deletions
packages/common/src/api/tan-query/users/useUnfollowUser.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,15 +4,15 @@ import { useDispatch } from 'react-redux'

import { useQueryContext } from '~/api/tan-query/utils/QueryContext'
import { useAppContext } from '~/context/appContext'
import { Kind } from '~/models'
import { Name, FollowSource } from '~/models/Analytics'
import { Feature } from '~/models/ErrorReporting'
import { ID } from '~/models/Identifiers'
import { UserMetadata } from '~/models/User'
import { update } from '~/store/cache/actions'
import { removeFolloweeId } from '~/store/gated-content/slice'
import { revokeFollowGatedAccess } from '~/store/tipping/slice'

import { primeUserData } from '../utils/primeUserData'

import { useCurrentUserId } from './account/useCurrentUserId'
import { getUserQueryKey } from './useUser'

Expand DownExpand Up@@ -84,17 +84,25 @@ export const useUnfollowUser = () => {
 ...previousUser,
 ...followeeUpdate
 }
 queryClient.setQueryData(getUserQueryKey(followeeUserId), updatedUser)
 primeUserData({
 users: [updatedUser],
 queryClient,
 forceReplace: true
 })
 }
 dispatch(update(Kind.USERS, [{ id: followeeUserId, metadata: update }]))

 const currentUser = queryClient.getQueryData(
 getUserQueryKey(currentUserId)
 )
 if (currentUser) {
queryClient.setQueryData(getUserQueryKey(currentUserId), {
const updatedCurrentUser = {
 ...currentUser,
 followee_count: Math.max((currentUser?.followee_count ?? 0) - 1, 0)
 }
 primeUserData({
 users: [updatedCurrentUser],
 queryClient,
 forceReplace: true
 })
 }

Expand All@@ -108,7 +116,11 @@ export const useUnfollowUser = () => {
 const { previousUser } = context ?? {}

 if (previousUser) {
 queryClient.setQueryData(getUserQueryKey(followeeUserId), previousUser)
 primeUserData({
 users: [previousUser],
 queryClient,
 forceReplace: true
 })
 }

 reportToSentry({
Expand Down

23 changes: 18 additions & 5 deletions
packages/common/src/api/tan-query/users/useUpdateUser.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,8 @@ import { ID } from '~/models/Identifiers'
import { PlaylistLibrary } from '~/models/PlaylistLibrary'
import { UserMetadata } from '~/models/User'

import { primeUserData } from '../utils/primeUserData'

import { getUserQueryKey } from './useUser'

type MutationContext = {
Expand DownExpand Up@@ -49,18 +51,29 @@ export const useUpdateUser = () => {
 const previousUser = queryClient.getQueryData(getUserQueryKey(userId))

 // Optimistically update user
 queryClient.setQueryData(getUserQueryKey(userId), (old: any) => ({
 ...old,
 ...metadata
 }))
 if (previousUser) {
 const updatedUser = {
 ...previousUser,
 ...metadata
 }
 primeUserData({
 users: [updatedUser],
 queryClient,
 forceReplace: true
 })
 }

 // Return context with the previous user
 return { previousUser }
 },
 onError: (_err, { userId }, context?: MutationContext) => {
 // If the mutation fails, roll back user data
 if (context?.previousUser) {
 queryClient.setQueryData(getUserQueryKey(userId), context.previousUser)
 primeUserData({
 users: [context.previousUser],
 queryClient,
 forceReplace: true
 })
 }
 },
 onSettled: (_, __) => {
Expand Down

29 changes: 23 additions & 6 deletions
packages/common/src/api/tan-query/utils/updateCollectionData.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,20 +7,37 @@ import { mergeCustomizer } from '~/store/cache/mergeCustomizer'

import { getCollectionQueryKey } from '../collection/useCollection'

import { primeCollectionData } from './primeCollectionData'

type PartialCollectionUpdate = Partial<Collection> & { playlist_id: ID }

export const updateCollectionData = function* (
 partialCollections: PartialCollectionUpdate[]
) {
 const queryClient = yield* getContext<QueryClient>('queryClient')

 partialCollections.forEach((partialCollection) => {
 // Get existing collection data and merge with updates
 const collectionsToUpdate = partialCollections.map((partialCollection) => {
 const { playlist_id } = partialCollection
 const existingCollection = queryClient.getQueryData(
 getCollectionQueryKey(playlist_id)
 ) as Collection | undefined

 if (existingCollection) {
 return mergeWith(
 {},
 existingCollection,
 partialCollection,
 mergeCustomizer
 )
 }
 return partialCollection as Collection
 })

 queryClient.setQueryData(
 getCollectionQueryKey(playlist_id),
 // TODO: drop the merge customizer once we're fully off of redux
 (prev) => prev && mergeWith({}, prev, partialCollection, mergeCustomizer)
)
// Use primeCollectionData with forceReplace to ensure updates are saved
primeCollectionData({
collections: collectionsToUpdate,
queryClient,
forceReplace: true
 })
}

25 changes: 18 additions & 7 deletions
packages/common/src/api/tan-query/utils/updateTrackData.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,8 @@ import { mergeCustomizer } from '~/store/cache/mergeCustomizer'

import { getTrackQueryKey } from '../tracks/useTrack'

import { primeTrackData } from './primeTrackData'

type PartialTrackUpdate = Partial<Track> & { track_id: ID }

/**
Expand All@@ -27,14 +29,23 @@ type PartialTrackUpdate = Partial<Track> & { track_id: ID }
export const updateTrackData = function* (partialTracks: PartialTrackUpdate[]) {
 const queryClient = yield* getContext<QueryClient>('queryClient')

 partialTracks.forEach((partialTrack) => {
 // Get existing track data and merge with updates
 const tracksToUpdate = partialTracks.map((partialTrack) => {
 const { track_id } = partialTrack
 const existingTrack = queryClient.getQueryData(
 getTrackQueryKey(track_id)
 ) as Track | undefined

 if (existingTrack) {
 return mergeWith({}, existingTrack, partialTrack, mergeCustomizer)
 }
 return partialTrack as Track
 })

 // Update react-query store
 queryClient.setQueryData(
 getTrackQueryKey(track_id),
 // TODO: drop the merge customizer once we're fully off of redux
 (prev) => prev && mergeWith({}, prev, partialTrack, mergeCustomizer)
 )
 // Use primeTrackData with forceReplace to ensure updates are saved
 primeTrackData({
 tracks: tracksToUpdate,
 queryClient,
 forceReplace: true
 })
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
Use prime functions for entity updates by dylanjeffers · Pull Request #12421 · AudiusProject/apps · GitHub
Skip to content
Use prime functions for entity updates#12421

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

dylanjeffers
merged 1 commit into

from

Jun 26, 2025
 Merged


Use prime functions for entity updates
#12421
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


9 changes: 5 additions & 4 deletions
packages/common/src/api/tan-query/collection/useUpdateCollection.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -179,10 +179,11 @@ export const useUpdateCollection = () => {
 onError: (_err, { collectionId }, context?: MutationContext) => {
 // If the mutation fails, roll back collection data
 if (context?.previousCollection) {
 queryClient.setQueryData(
 getCollectionQueryKey(collectionId),
 context.previousCollection
 )
 primeCollectionData({
 collections: [context.previousCollection],
 queryClient,
 forceReplace: true
 })
 }
 },
 onSettled: (_, __, { collectionId }) => {
Expand Down

6 changes: 5 additions & 1 deletion
packages/common/src/api/tan-query/tracks/useFavoriteTrack.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -155,7 +155,11 @@ export const useFavoriteTrack = () => {
 if (!context) return

 // Revert optimistic updates
 queryClient.setQueryData(getTrackQueryKey(trackId), context.previousTrack)
 primeTrackData({
 tracks: [context.previousTrack],
 queryClient,
 forceReplace: true
 })
 dispatch(accountActions.decrementTrackSaveCount())

 reportToSentry({
Expand Down

6 changes: 5 additions & 1 deletion
packages/common/src/api/tan-query/tracks/useUnfavoriteTrack.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -126,7 +126,11 @@ export const useUnfavoriteTrack = () => {
 if (!context) return

 // Revert optimistic updates
 queryClient.setQueryData(getTrackQueryKey(trackId), context.previousTrack)
 primeTrackData({
 tracks: [context.previousTrack],
 queryClient,
 forceReplace: true
 })
 dispatch(accountActions.incrementTrackSaveCount())

 reportToSentry({
Expand Down

9 changes: 5 additions & 4 deletions
packages/common/src/api/tan-query/tracks/useUpdateTrack.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,10 +111,11 @@ export const useUpdateTrack = () => {
 ) => {
 // If the mutation fails, roll back track data
 if (context?.previousTrack) {
 queryClient.setQueryData(
 getTrackQueryKey(trackId),
 context.previousTrack
 )
 primeTrackData({
 tracks: [context.previousTrack],
 queryClient,
 forceReplace: true
 })
 }

 // Roll back all collections that contain this track
Expand Down

26 changes: 18 additions & 8 deletions
packages/common/src/api/tan-query/users/useFollowUser.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,12 +5,12 @@ import { useDispatch } from 'react-redux'

import { useQueryContext } from '~/api/tan-query/utils'
import { useAppContext } from '~/context/appContext'
import { Kind } from '~/models'
import { Name, FollowSource } from '~/models/Analytics'
import { Feature } from '~/models/ErrorReporting'
import { ID } from '~/models/Identifiers'
import { UserMetadata } from '~/models/User'
import { update } from '~/store/cache/actions'

import { primeUserData } from '../utils/primeUserData'

import { useCurrentUserId } from './account/useCurrentUserId'
import { getUserQueryKey } from './useUser'
Expand DownExpand Up@@ -91,19 +91,25 @@ export const useFollowUser = () => {
 ...previousUser,
 ...followeeUpdate
 }
 queryClient.setQueryData(getUserQueryKey(followeeUserId), updatedUser)
 primeUserData({
 users: [updatedUser],
 queryClient,
 forceReplace: true
 })
 }
 dispatch(
 update(Kind.USERS, [{ id: followeeUserId, metadata: followeeUpdate }])
 )

 const currentUser = queryClient.getQueryData(
 getUserQueryKey(currentUserId)
 )
 if (currentUser) {
queryClient.setQueryData(getUserQueryKey(currentUserId), {
const updatedCurrentUser = {
 ...currentUser,
 followee_count: (currentUser?.followee_count ?? 0) + 1
 }
 primeUserData({
 users: [updatedCurrentUser],
 queryClient,
 forceReplace: true
 })
 }

Expand All@@ -117,7 +123,11 @@ export const useFollowUser = () => {
 const { previousUser } = context ?? {}

 if (previousUser) {
 queryClient.setQueryData(getUserQueryKey(followeeUserId), previousUser)
 primeUserData({
 users: [previousUser],
 queryClient,
 forceReplace: true
 })
 }

 reportToSentry({
Expand Down

24 changes: 18 additions & 6 deletions
packages/common/src/api/tan-query/users/useUnfollowUser.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,15 +4,15 @@ import { useDispatch } from 'react-redux'

import { useQueryContext } from '~/api/tan-query/utils/QueryContext'
import { useAppContext } from '~/context/appContext'
import { Kind } from '~/models'
import { Name, FollowSource } from '~/models/Analytics'
import { Feature } from '~/models/ErrorReporting'
import { ID } from '~/models/Identifiers'
import { UserMetadata } from '~/models/User'
import { update } from '~/store/cache/actions'
import { removeFolloweeId } from '~/store/gated-content/slice'
import { revokeFollowGatedAccess } from '~/store/tipping/slice'

import { primeUserData } from '../utils/primeUserData'

import { useCurrentUserId } from './account/useCurrentUserId'
import { getUserQueryKey } from './useUser'

Expand DownExpand Up@@ -84,17 +84,25 @@ export const useUnfollowUser = () => {
 ...previousUser,
 ...followeeUpdate
 }
 queryClient.setQueryData(getUserQueryKey(followeeUserId), updatedUser)
 primeUserData({
 users: [updatedUser],
 queryClient,
 forceReplace: true
 })
 }
 dispatch(update(Kind.USERS, [{ id: followeeUserId, metadata: update }]))

 const currentUser = queryClient.getQueryData(
 getUserQueryKey(currentUserId)
 )
 if (currentUser) {
queryClient.setQueryData(getUserQueryKey(currentUserId), {
const updatedCurrentUser = {
 ...currentUser,
 followee_count: Math.max((currentUser?.followee_count ?? 0) - 1, 0)
 }
 primeUserData({
 users: [updatedCurrentUser],
 queryClient,
 forceReplace: true
 })
 }

Expand All@@ -108,7 +116,11 @@ export const useUnfollowUser = () => {
 const { previousUser } = context ?? {}

 if (previousUser) {
 queryClient.setQueryData(getUserQueryKey(followeeUserId), previousUser)
 primeUserData({
 users: [previousUser],
 queryClient,
 forceReplace: true
 })
 }

 reportToSentry({
Expand Down

23 changes: 18 additions & 5 deletions
packages/common/src/api/tan-query/users/useUpdateUser.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,8 @@ import { ID } from '~/models/Identifiers'
import { PlaylistLibrary } from '~/models/PlaylistLibrary'
import { UserMetadata } from '~/models/User'

import { primeUserData } from '../utils/primeUserData'

import { getUserQueryKey } from './useUser'

type MutationContext = {
Expand DownExpand Up@@ -49,18 +51,29 @@ export const useUpdateUser = () => {
 const previousUser = queryClient.getQueryData(getUserQueryKey(userId))

 // Optimistically update user
 queryClient.setQueryData(getUserQueryKey(userId), (old: any) => ({
 ...old,
 ...metadata
 }))
 if (previousUser) {
 const updatedUser = {
 ...previousUser,
 ...metadata
 }
 primeUserData({
 users: [updatedUser],
 queryClient,
 forceReplace: true
 })
 }

 // Return context with the previous user
 return { previousUser }
 },
 onError: (_err, { userId }, context?: MutationContext) => {
 // If the mutation fails, roll back user data
 if (context?.previousUser) {
 queryClient.setQueryData(getUserQueryKey(userId), context.previousUser)
 primeUserData({
 users: [context.previousUser],
 queryClient,
 forceReplace: true
 })
 }
 },
 onSettled: (_, __) => {
Expand Down

29 changes: 23 additions & 6 deletions
packages/common/src/api/tan-query/utils/updateCollectionData.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,20 +7,37 @@ import { mergeCustomizer } from '~/store/cache/mergeCustomizer'

import { getCollectionQueryKey } from '../collection/useCollection'

import { primeCollectionData } from './primeCollectionData'

type PartialCollectionUpdate = Partial<Collection> & { playlist_id: ID }

export const updateCollectionData = function* (
 partialCollections: PartialCollectionUpdate[]
) {
 const queryClient = yield* getContext<QueryClient>('queryClient')

 partialCollections.forEach((partialCollection) => {
 // Get existing collection data and merge with updates
 const collectionsToUpdate = partialCollections.map((partialCollection) => {
 const { playlist_id } = partialCollection
 const existingCollection = queryClient.getQueryData(
 getCollectionQueryKey(playlist_id)
 ) as Collection | undefined

 if (existingCollection) {
 return mergeWith(
 {},
 existingCollection,
 partialCollection,
 mergeCustomizer
 )
 }
 return partialCollection as Collection
 })

 queryClient.setQueryData(
 getCollectionQueryKey(playlist_id),
 // TODO: drop the merge customizer once we're fully off of redux
 (prev) => prev && mergeWith({}, prev, partialCollection, mergeCustomizer)
)
// Use primeCollectionData with forceReplace to ensure updates are saved
primeCollectionData({
collections: collectionsToUpdate,
queryClient,
forceReplace: true
 })
}

25 changes: 18 additions & 7 deletions
packages/common/src/api/tan-query/utils/updateTrackData.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,8 @@ import { mergeCustomizer } from '~/store/cache/mergeCustomizer'

import { getTrackQueryKey } from '../tracks/useTrack'

import { primeTrackData } from './primeTrackData'

type PartialTrackUpdate = Partial<Track> & { track_id: ID }

/**
Expand All@@ -27,14 +29,23 @@ type PartialTrackUpdate = Partial<Track> & { track_id: ID }
export const updateTrackData = function* (partialTracks: PartialTrackUpdate[]) {
 const queryClient = yield* getContext<QueryClient>('queryClient')

 partialTracks.forEach((partialTrack) => {
 // Get existing track data and merge with updates
 const tracksToUpdate = partialTracks.map((partialTrack) => {
 const { track_id } = partialTrack
 const existingTrack = queryClient.getQueryData(
 getTrackQueryKey(track_id)
 ) as Track | undefined

 if (existingTrack) {
 return mergeWith({}, existingTrack, partialTrack, mergeCustomizer)
 }
 return partialTrack as Track
 })

 // Update react-query store
 queryClient.setQueryData(
 getTrackQueryKey(track_id),
 // TODO: drop the merge customizer once we're fully off of redux
 (prev) => prev && mergeWith({}, prev, partialTrack, mergeCustomizer)
 )
 // Use primeTrackData with forceReplace to ensure updates are saved
 primeTrackData({
 tracks: tracksToUpdate,
 queryClient,
 forceReplace: true
 })
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Use prime functions for entity updates by dylanjeffers · Pull Request #12421 · AudiusProject/apps · GitHub
Skip to content
Use prime functions for entity updates#12421

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

dylanjeffers
merged 1 commit into

from

Jun 26, 2025
 Merged


Use prime functions for entity updates
#12421
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


9 changes: 5 additions & 4 deletions
packages/common/src/api/tan-query/collection/useUpdateCollection.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -179,10 +179,11 @@ export const useUpdateCollection = () => {
 onError: (_err, { collectionId }, context?: MutationContext) => {
 // If the mutation fails, roll back collection data
 if (context?.previousCollection) {
 queryClient.setQueryData(
 getCollectionQueryKey(collectionId),
 context.previousCollection
 )
 primeCollectionData({
 collections: [context.previousCollection],
 queryClient,
 forceReplace: true
 })
 }
 },
 onSettled: (_, __, { collectionId }) => {
Expand Down

6 changes: 5 additions & 1 deletion
packages/common/src/api/tan-query/tracks/useFavoriteTrack.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -155,7 +155,11 @@ export const useFavoriteTrack = () => {
 if (!context) return

 // Revert optimistic updates
 queryClient.setQueryData(getTrackQueryKey(trackId), context.previousTrack)
 primeTrackData({
 tracks: [context.previousTrack],
 queryClient,
 forceReplace: true
 })
 dispatch(accountActions.decrementTrackSaveCount())

 reportToSentry({
Expand Down

6 changes: 5 additions & 1 deletion
packages/common/src/api/tan-query/tracks/useUnfavoriteTrack.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -126,7 +126,11 @@ export const useUnfavoriteTrack = () => {
 if (!context) return

 // Revert optimistic updates
 queryClient.setQueryData(getTrackQueryKey(trackId), context.previousTrack)
 primeTrackData({
 tracks: [context.previousTrack],
 queryClient,
 forceReplace: true
 })
 dispatch(accountActions.incrementTrackSaveCount())

 reportToSentry({
Expand Down

9 changes: 5 additions & 4 deletions
packages/common/src/api/tan-query/tracks/useUpdateTrack.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,10 +111,11 @@ export const useUpdateTrack = () => {
 ) => {
 // If the mutation fails, roll back track data
 if (context?.previousTrack) {
 queryClient.setQueryData(
 getTrackQueryKey(trackId),
 context.previousTrack
 )
 primeTrackData({
 tracks: [context.previousTrack],
 queryClient,
 forceReplace: true
 })
 }

 // Roll back all collections that contain this track
Expand Down

26 changes: 18 additions & 8 deletions
packages/common/src/api/tan-query/users/useFollowUser.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,12 +5,12 @@ import { useDispatch } from 'react-redux'

import { useQueryContext } from '~/api/tan-query/utils'
import { useAppContext } from '~/context/appContext'
import { Kind } from '~/models'
import { Name, FollowSource } from '~/models/Analytics'
import { Feature } from '~/models/ErrorReporting'
import { ID } from '~/models/Identifiers'
import { UserMetadata } from '~/models/User'
import { update } from '~/store/cache/actions'

import { primeUserData } from '../utils/primeUserData'

import { useCurrentUserId } from './account/useCurrentUserId'
import { getUserQueryKey } from './useUser'
Expand DownExpand Up@@ -91,19 +91,25 @@ export const useFollowUser = () => {
 ...previousUser,
 ...followeeUpdate
 }
 queryClient.setQueryData(getUserQueryKey(followeeUserId), updatedUser)
 primeUserData({
 users: [updatedUser],
 queryClient,
 forceReplace: true
 })
 }
 dispatch(
 update(Kind.USERS, [{ id: followeeUserId, metadata: followeeUpdate }])
 )

 const currentUser = queryClient.getQueryData(
 getUserQueryKey(currentUserId)
 )
 if (currentUser) {
queryClient.setQueryData(getUserQueryKey(currentUserId), {
const updatedCurrentUser = {
 ...currentUser,
 followee_count: (currentUser?.followee_count ?? 0) + 1
 }
 primeUserData({
 users: [updatedCurrentUser],
 queryClient,
 forceReplace: true
 })
 }

Expand All@@ -117,7 +123,11 @@ export const useFollowUser = () => {
 const { previousUser } = context ?? {}

 if (previousUser) {
 queryClient.setQueryData(getUserQueryKey(followeeUserId), previousUser)
 primeUserData({
 users: [previousUser],
 queryClient,
 forceReplace: true
 })
 }

 reportToSentry({
Expand Down

24 changes: 18 additions & 6 deletions
packages/common/src/api/tan-query/users/useUnfollowUser.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,15 +4,15 @@ import { useDispatch } from 'react-redux'

import { useQueryContext } from '~/api/tan-query/utils/QueryContext'
import { useAppContext } from '~/context/appContext'
import { Kind } from '~/models'
import { Name, FollowSource } from '~/models/Analytics'
import { Feature } from '~/models/ErrorReporting'
import { ID } from '~/models/Identifiers'
import { UserMetadata } from '~/models/User'
import { update } from '~/store/cache/actions'
import { removeFolloweeId } from '~/store/gated-content/slice'
import { revokeFollowGatedAccess } from '~/store/tipping/slice'

import { primeUserData } from '../utils/primeUserData'

import { useCurrentUserId } from './account/useCurrentUserId'
import { getUserQueryKey } from './useUser'

Expand DownExpand Up@@ -84,17 +84,25 @@ export const useUnfollowUser = () => {
 ...previousUser,
 ...followeeUpdate
 }
 queryClient.setQueryData(getUserQueryKey(followeeUserId), updatedUser)
 primeUserData({
 users: [updatedUser],
 queryClient,
 forceReplace: true
 })
 }
 dispatch(update(Kind.USERS, [{ id: followeeUserId, metadata: update }]))

 const currentUser = queryClient.getQueryData(
 getUserQueryKey(currentUserId)
 )
 if (currentUser) {
queryClient.setQueryData(getUserQueryKey(currentUserId), {
const updatedCurrentUser = {
 ...currentUser,
 followee_count: Math.max((currentUser?.followee_count ?? 0) - 1, 0)
 }
 primeUserData({
 users: [updatedCurrentUser],
 queryClient,
 forceReplace: true
 })
 }

Expand All@@ -108,7 +116,11 @@ export const useUnfollowUser = () => {
 const { previousUser } = context ?? {}

 if (previousUser) {
 queryClient.setQueryData(getUserQueryKey(followeeUserId), previousUser)
 primeUserData({
 users: [previousUser],
 queryClient,
 forceReplace: true
 })
 }

 reportToSentry({
Expand Down

23 changes: 18 additions & 5 deletions
packages/common/src/api/tan-query/users/useUpdateUser.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,8 @@ import { ID } from '~/models/Identifiers'
import { PlaylistLibrary } from '~/models/PlaylistLibrary'
import { UserMetadata } from '~/models/User'

import { primeUserData } from '../utils/primeUserData'

import { getUserQueryKey } from './useUser'

type MutationContext = {
Expand DownExpand Up@@ -49,18 +51,29 @@ export const useUpdateUser = () => {
 const previousUser = queryClient.getQueryData(getUserQueryKey(userId))

 // Optimistically update user
 queryClient.setQueryData(getUserQueryKey(userId), (old: any) => ({
 ...old,
 ...metadata
 }))
 if (previousUser) {
 const updatedUser = {
 ...previousUser,
 ...metadata
 }
 primeUserData({
 users: [updatedUser],
 queryClient,
 forceReplace: true
 })
 }

 // Return context with the previous user
 return { previousUser }
 },
 onError: (_err, { userId }, context?: MutationContext) => {
 // If the mutation fails, roll back user data
 if (context?.previousUser) {
 queryClient.setQueryData(getUserQueryKey(userId), context.previousUser)
 primeUserData({
 users: [context.previousUser],
 queryClient,
 forceReplace: true
 })
 }
 },
 onSettled: (_, __) => {
Expand Down

29 changes: 23 additions & 6 deletions
packages/common/src/api/tan-query/utils/updateCollectionData.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,20 +7,37 @@ import { mergeCustomizer } from '~/store/cache/mergeCustomizer'

import { getCollectionQueryKey } from '../collection/useCollection'

import { primeCollectionData } from './primeCollectionData'

type PartialCollectionUpdate = Partial<Collection> & { playlist_id: ID }

export const updateCollectionData = function* (
 partialCollections: PartialCollectionUpdate[]
) {
 const queryClient = yield* getContext<QueryClient>('queryClient')

 partialCollections.forEach((partialCollection) => {
 // Get existing collection data and merge with updates
 const collectionsToUpdate = partialCollections.map((partialCollection) => {
 const { playlist_id } = partialCollection
 const existingCollection = queryClient.getQueryData(
 getCollectionQueryKey(playlist_id)
 ) as Collection | undefined

 if (existingCollection) {
 return mergeWith(
 {},
 existingCollection,
 partialCollection,
 mergeCustomizer
 )
 }
 return partialCollection as Collection
 })

 queryClient.setQueryData(
 getCollectionQueryKey(playlist_id),
 // TODO: drop the merge customizer once we're fully off of redux
 (prev) => prev && mergeWith({}, prev, partialCollection, mergeCustomizer)
)
// Use primeCollectionData with forceReplace to ensure updates are saved
primeCollectionData({
collections: collectionsToUpdate,
queryClient,
forceReplace: true
 })
}

25 changes: 18 additions & 7 deletions
packages/common/src/api/tan-query/utils/updateTrackData.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,8 @@ import { mergeCustomizer } from '~/store/cache/mergeCustomizer'

import { getTrackQueryKey } from '../tracks/useTrack'

import { primeTrackData } from './primeTrackData'

type PartialTrackUpdate = Partial<Track> & { track_id: ID }

/**
Expand All@@ -27,14 +29,23 @@ type PartialTrackUpdate = Partial<Track> & { track_id: ID }
export const updateTrackData = function* (partialTracks: PartialTrackUpdate[]) {
 const queryClient = yield* getContext<QueryClient>('queryClient')

 partialTracks.forEach((partialTrack) => {
 // Get existing track data and merge with updates
 const tracksToUpdate = partialTracks.map((partialTrack) => {
 const { track_id } = partialTrack
 const existingTrack = queryClient.getQueryData(
 getTrackQueryKey(track_id)
 ) as Track | undefined

 if (existingTrack) {
 return mergeWith({}, existingTrack, partialTrack, mergeCustomizer)
 }
 return partialTrack as Track
 })

 // Update react-query store
 queryClient.setQueryData(
 getTrackQueryKey(track_id),
 // TODO: drop the merge customizer once we're fully off of redux
 (prev) => prev && mergeWith({}, prev, partialTrack, mergeCustomizer)
 )
 // Use primeTrackData with forceReplace to ensure updates are saved
 primeTrackData({
 tracks: tracksToUpdate,
 queryClient,
 forceReplace: true
 })
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
})();
Use prime functions for entity updates by dylanjeffers · Pull Request #12421 · AudiusProject/apps · GitHub
Skip to content
Use prime functions for entity updates#12421

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

dylanjeffers
merged 1 commit into

from

Jun 26, 2025
 Merged


Use prime functions for entity updates
#12421
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


9 changes: 5 additions & 4 deletions
packages/common/src/api/tan-query/collection/useUpdateCollection.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -179,10 +179,11 @@ export const useUpdateCollection = () => {
 onError: (_err, { collectionId }, context?: MutationContext) => {
 // If the mutation fails, roll back collection data
 if (context?.previousCollection) {
 queryClient.setQueryData(
 getCollectionQueryKey(collectionId),
 context.previousCollection
 )
 primeCollectionData({
 collections: [context.previousCollection],
 queryClient,
 forceReplace: true
 })
 }
 },
 onSettled: (_, __, { collectionId }) => {
Expand Down

6 changes: 5 additions & 1 deletion
packages/common/src/api/tan-query/tracks/useFavoriteTrack.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -155,7 +155,11 @@ export const useFavoriteTrack = () => {
 if (!context) return

 // Revert optimistic updates
 queryClient.setQueryData(getTrackQueryKey(trackId), context.previousTrack)
 primeTrackData({
 tracks: [context.previousTrack],
 queryClient,
 forceReplace: true
 })
 dispatch(accountActions.decrementTrackSaveCount())

 reportToSentry({
Expand Down

6 changes: 5 additions & 1 deletion
packages/common/src/api/tan-query/tracks/useUnfavoriteTrack.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -126,7 +126,11 @@ export const useUnfavoriteTrack = () => {
 if (!context) return

 // Revert optimistic updates
 queryClient.setQueryData(getTrackQueryKey(trackId), context.previousTrack)
 primeTrackData({
 tracks: [context.previousTrack],
 queryClient,
 forceReplace: true
 })
 dispatch(accountActions.incrementTrackSaveCount())

 reportToSentry({
Expand Down

9 changes: 5 additions & 4 deletions
packages/common/src/api/tan-query/tracks/useUpdateTrack.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,10 +111,11 @@ export const useUpdateTrack = () => {
 ) => {
 // If the mutation fails, roll back track data
 if (context?.previousTrack) {
 queryClient.setQueryData(
 getTrackQueryKey(trackId),
 context.previousTrack
 )
 primeTrackData({
 tracks: [context.previousTrack],
 queryClient,
 forceReplace: true
 })
 }

 // Roll back all collections that contain this track
Expand Down

26 changes: 18 additions & 8 deletions
packages/common/src/api/tan-query/users/useFollowUser.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,12 +5,12 @@ import { useDispatch } from 'react-redux'

import { useQueryContext } from '~/api/tan-query/utils'
import { useAppContext } from '~/context/appContext'
import { Kind } from '~/models'
import { Name, FollowSource } from '~/models/Analytics'
import { Feature } from '~/models/ErrorReporting'
import { ID } from '~/models/Identifiers'
import { UserMetadata } from '~/models/User'
import { update } from '~/store/cache/actions'

import { primeUserData } from '../utils/primeUserData'

import { useCurrentUserId } from './account/useCurrentUserId'
import { getUserQueryKey } from './useUser'
Expand DownExpand Up@@ -91,19 +91,25 @@ export const useFollowUser = () => {
 ...previousUser,
 ...followeeUpdate
 }
 queryClient.setQueryData(getUserQueryKey(followeeUserId), updatedUser)
 primeUserData({
 users: [updatedUser],
 queryClient,
 forceReplace: true
 })
 }
 dispatch(
 update(Kind.USERS, [{ id: followeeUserId, metadata: followeeUpdate }])
 )

 const currentUser = queryClient.getQueryData(
 getUserQueryKey(currentUserId)
 )
 if (currentUser) {
queryClient.setQueryData(getUserQueryKey(currentUserId), {
const updatedCurrentUser = {
 ...currentUser,
 followee_count: (currentUser?.followee_count ?? 0) + 1
 }
 primeUserData({
 users: [updatedCurrentUser],
 queryClient,
 forceReplace: true
 })
 }

Expand All@@ -117,7 +123,11 @@ export const useFollowUser = () => {
 const { previousUser } = context ?? {}

 if (previousUser) {
 queryClient.setQueryData(getUserQueryKey(followeeUserId), previousUser)
 primeUserData({
 users: [previousUser],
 queryClient,
 forceReplace: true
 })
 }

 reportToSentry({
Expand Down

24 changes: 18 additions & 6 deletions
packages/common/src/api/tan-query/users/useUnfollowUser.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,15 +4,15 @@ import { useDispatch } from 'react-redux'

import { useQueryContext } from '~/api/tan-query/utils/QueryContext'
import { useAppContext } from '~/context/appContext'
import { Kind } from '~/models'
import { Name, FollowSource } from '~/models/Analytics'
import { Feature } from '~/models/ErrorReporting'
import { ID } from '~/models/Identifiers'
import { UserMetadata } from '~/models/User'
import { update } from '~/store/cache/actions'
import { removeFolloweeId } from '~/store/gated-content/slice'
import { revokeFollowGatedAccess } from '~/store/tipping/slice'

import { primeUserData } from '../utils/primeUserData'

import { useCurrentUserId } from './account/useCurrentUserId'
import { getUserQueryKey } from './useUser'

Expand DownExpand Up@@ -84,17 +84,25 @@ export const useUnfollowUser = () => {
 ...previousUser,
 ...followeeUpdate
 }
 queryClient.setQueryData(getUserQueryKey(followeeUserId), updatedUser)
 primeUserData({
 users: [updatedUser],
 queryClient,
 forceReplace: true
 })
 }
 dispatch(update(Kind.USERS, [{ id: followeeUserId, metadata: update }]))

 const currentUser = queryClient.getQueryData(
 getUserQueryKey(currentUserId)
 )
 if (currentUser) {
queryClient.setQueryData(getUserQueryKey(currentUserId), {
const updatedCurrentUser = {
 ...currentUser,
 followee_count: Math.max((currentUser?.followee_count ?? 0) - 1, 0)
 }
 primeUserData({
 users: [updatedCurrentUser],
 queryClient,
 forceReplace: true
 })
 }

Expand All@@ -108,7 +116,11 @@ export const useUnfollowUser = () => {
 const { previousUser } = context ?? {}

 if (previousUser) {
 queryClient.setQueryData(getUserQueryKey(followeeUserId), previousUser)
 primeUserData({
 users: [previousUser],
 queryClient,
 forceReplace: true
 })
 }

 reportToSentry({
Expand Down

23 changes: 18 additions & 5 deletions
packages/common/src/api/tan-query/users/useUpdateUser.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,8 @@ import { ID } from '~/models/Identifiers'
import { PlaylistLibrary } from '~/models/PlaylistLibrary'
import { UserMetadata } from '~/models/User'

import { primeUserData } from '../utils/primeUserData'

import { getUserQueryKey } from './useUser'

type MutationContext = {
Expand DownExpand Up@@ -49,18 +51,29 @@ export const useUpdateUser = () => {
 const previousUser = queryClient.getQueryData(getUserQueryKey(userId))

 // Optimistically update user
 queryClient.setQueryData(getUserQueryKey(userId), (old: any) => ({
 ...old,
 ...metadata
 }))
 if (previousUser) {
 const updatedUser = {
 ...previousUser,
 ...metadata
 }
 primeUserData({
 users: [updatedUser],
 queryClient,
 forceReplace: true
 })
 }

 // Return context with the previous user
 return { previousUser }
 },
 onError: (_err, { userId }, context?: MutationContext) => {
 // If the mutation fails, roll back user data
 if (context?.previousUser) {
 queryClient.setQueryData(getUserQueryKey(userId), context.previousUser)
 primeUserData({
 users: [context.previousUser],
 queryClient,
 forceReplace: true
 })
 }
 },
 onSettled: (_, __) => {
Expand Down

29 changes: 23 additions & 6 deletions
packages/common/src/api/tan-query/utils/updateCollectionData.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,20 +7,37 @@ import { mergeCustomizer } from '~/store/cache/mergeCustomizer'

import { getCollectionQueryKey } from '../collection/useCollection'

import { primeCollectionData } from './primeCollectionData'

type PartialCollectionUpdate = Partial<Collection> & { playlist_id: ID }

export const updateCollectionData = function* (
 partialCollections: PartialCollectionUpdate[]
) {
 const queryClient = yield* getContext<QueryClient>('queryClient')

 partialCollections.forEach((partialCollection) => {
 // Get existing collection data and merge with updates
 const collectionsToUpdate = partialCollections.map((partialCollection) => {
 const { playlist_id } = partialCollection
 const existingCollection = queryClient.getQueryData(
 getCollectionQueryKey(playlist_id)
 ) as Collection | undefined

 if (existingCollection) {
 return mergeWith(
 {},
 existingCollection,
 partialCollection,
 mergeCustomizer
 )
 }
 return partialCollection as Collection
 })

 queryClient.setQueryData(
 getCollectionQueryKey(playlist_id),
 // TODO: drop the merge customizer once we're fully off of redux
 (prev) => prev && mergeWith({}, prev, partialCollection, mergeCustomizer)
)
// Use primeCollectionData with forceReplace to ensure updates are saved
primeCollectionData({
collections: collectionsToUpdate,
queryClient,
forceReplace: true
 })
}

25 changes: 18 additions & 7 deletions
packages/common/src/api/tan-query/utils/updateTrackData.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,8 @@ import { mergeCustomizer } from '~/store/cache/mergeCustomizer'

import { getTrackQueryKey } from '../tracks/useTrack'

import { primeTrackData } from './primeTrackData'

type PartialTrackUpdate = Partial<Track> & { track_id: ID }

/**
Expand All@@ -27,14 +29,23 @@ type PartialTrackUpdate = Partial<Track> & { track_id: ID }
export const updateTrackData = function* (partialTracks: PartialTrackUpdate[]) {
 const queryClient = yield* getContext<QueryClient>('queryClient')

 partialTracks.forEach((partialTrack) => {
 // Get existing track data and merge with updates
 const tracksToUpdate = partialTracks.map((partialTrack) => {
 const { track_id } = partialTrack
 const existingTrack = queryClient.getQueryData(
 getTrackQueryKey(track_id)
 ) as Track | undefined

 if (existingTrack) {
 return mergeWith({}, existingTrack, partialTrack, mergeCustomizer)
 }
 return partialTrack as Track
 })

 // Update react-query store
 queryClient.setQueryData(
 getTrackQueryKey(track_id),
 // TODO: drop the merge customizer once we're fully off of redux
 (prev) => prev && mergeWith({}, prev, partialTrack, mergeCustomizer)
 )
 // Use primeTrackData with forceReplace to ensure updates are saved
 primeTrackData({
 tracks: tracksToUpdate,
 queryClient,
 forceReplace: true
 })
}