[PE-6074] Deprecate useGetTrackByPermalink from a-query

packages/common/src/api/track.ts

@@ -10,69 +10,6 @@ import { SDKRequest } from './types'
 const trackApi = createApi({
   reducerPath: 'trackApi',
   endpoints: {
-    getTrackById: {
-      fetch: async (
-        {
-          id,
-          currentUserId
-        }: { id: ID | null | undefined; currentUserId?: Nullable<ID> },
-        { audiusSdk }
-      ) => {
-        if (!id || id === -1) return null
-        const sdk = await audiusSdk()
-        const { data } = await sdk.full.tracks.getTrack({
-          trackId: Id.parse(id),
-          userId: OptionalId.parse(currentUserId)
-        })
-        return data ? userTrackMetadataFromSDK(data) : null
-      },
-      fetchBatch: async (
-        { ids, currentUserId }: { ids: ID[]; currentUserId?: Nullable<ID> },
-        { audiusSdk }
-      ) => {
-        const id = ids.filter((id) => id && id !== -1).map((id) => Id.parse(id))
-        if (id.length === 0) return []
-
-        const sdk = await audiusSdk()
-        const { data = [] } = await sdk.full.tracks.getBulkTracks({
-          id,
-          userId: OptionalId.parse(currentUserId)
-        })
-        return transformAndCleanList(data, userTrackMetadataFromSDK)
-      },
-      options: {
-        idArgKey: 'id',
-        kind: Kind.TRACKS,
-        schemaKey: 'track'
-      }
-    },
-    getTrackByPermalink: {
-      fetch: async (
-        {
-          permalink,
-          currentUserId
-        }: { permalink: Nullable<string>; currentUserId: Nullable<ID> },
-        { audiusSdk }
-      ) => {
-        if (!permalink) {
-          console.error('Attempting to get track but permalink is null...')
-          return
-        }
-        const sdk = await audiusSdk()
-        const { data } = await sdk.full.tracks.getBulkTracks({
-          permalink: [permalink],
-          userId: OptionalId.parse(currentUserId)
-        })
-        return data && data.length > 0
-          ? userTrackMetadataFromSDK(data[0])
-          : null
-      },
-      options: {
-        permalinkArgKey: 'permalink',
-        kind: Kind.TRACKS,
-        schemaKey: 'track'
-      }
-    },
     getTracksByIds: {
       fetch: async (
         { ids, currentUserId }: { ids: ID[]; currentUserId: Nullable<ID> },
@@ -123,11 +60,7 @@ const trackApi = createApi({
   }
 })
 
-export const {
-  useGetTrackByPermalink,
-  useGetTracksByIds,
-  useGetUserTracksByHandle
-} = trackApi.hooks
+export const { useGetTracksByIds, useGetUserTracksByHandle } = trackApi.hooks
 export const trackApiFetch = trackApi.fetch
 export const trackApiReducer = trackApi.reducer
 export const trackApiActions = trackApi.actions

packages/common/src/hooks/useGatedContent.ts

@@ -66,7 +66,23 @@ export const useGatedCollectionAccess = (collectionId: ID) => {
 
 // Returns whether user has access to given track.
 export const useGatedContentAccess = (
-  content: Nullable<Partial<Track | Collection>> | undefined
+  content:
+    | Nullable<
+        | Pick<
+            Track,
+            | 'track_id'
+            | 'is_stream_gated'
+            | 'is_download_gated'
+            | 'access'
+            | 'stream_conditions'
+            | 'download_conditions'
+          >
+        | Pick<
+            Collection,
+            'playlist_id' | 'is_stream_gated' | 'access' | 'stream_conditions'
+          >
+      >
+    | undefined
 ) => {
   const nftAccessSignatureMap = useSelector(getNftAccessSignatureMap)
   const hasAccount = useSelector(getHasAccount)

packages/common/src/hooks/useTrackMetadata.ts

@@ -1,7 +1,7 @@
 import { Mood } from '@audius/sdk'
 import { pick } from 'lodash'
 
-import { useTrack } from '~/api/tan-query/useTrack'
+import { useTrack } from '~/api'
 import { ID } from '~/models'
 import { parseMusicalKey } from '~/utils/musicalKeys'
 import { searchPage } from '~/utils/route'

packages/mobile/src/screens/chat-screen/ChatMessageTrack.tsx

@@ -1,51 +1,53 @@
 import { useCallback, useEffect, useMemo } from 'react'
 
-import { useGetTrackByPermalink } from '@audius/common/api'
+import { useTrackByPermalink, useUser } from '@audius/common/api'
 import { useGatedContentAccess, useToggleTrack } from '@audius/common/hooks'
 import type { TrackPlayback } from '@audius/common/hooks'
 import { Name, PlaybackSource, Kind } from '@audius/common/models'
 import type { ID } from '@audius/common/models'
-import { accountSelectors, QueueSource } from '@audius/common/store'
+import { QueueSource } from '@audius/common/store'
 import type { ChatMessageTileProps } from '@audius/common/store'
 import { getPathFromTrackUrl, makeUid } from '@audius/common/utils'
-import { useSelector } from 'react-redux'
+import { pick } from 'lodash'
 
 import { TrackTile } from 'app/components/lineup-tile'
 import { LineupTileSource } from 'app/components/lineup-tile/types'
 import { make, track as trackEvent } from 'app/services/analytics'
 
-const { getUserId } = accountSelectors
-
 export const ChatMessageTrack = ({
   link,
   onEmpty,
   onSuccess,
   styles
 }: ChatMessageTileProps) => {
-  const currentUserId = useSelector(getUserId)
-
   const permalink = getPathFromTrackUrl(link)
-  const { data: track } = useGetTrackByPermalink(
-    {
-      permalink,
-      currentUserId
-    },
-    { disabled: !permalink }
-  )
-  const { hasStreamAccess } = useGatedContentAccess(track ?? null)
-  const isPreview =
-    !!track?.is_stream_gated && !!track?.preview_cid && !hasStreamAccess
-
-  const user = useMemo(() => (track ? { ...track.user } : null), [track])
+  const { data: partialTrack } = useTrackByPermalink(permalink, {
+    select: (track) =>
+      pick(track, [
+        'track_id',
+        'owner_id',
+        'preview_cid',
+        'access',
+        'is_download_gated',
+        'is_stream_gated',
+        'download_conditions',
+        'stream_conditions'
+      ])
+  })
+  const trackExists = !!partialTrack
+  const { hasStreamAccess } = useGatedContentAccess(partialTrack)
+  const { track_id, is_stream_gated, preview_cid, owner_id } =
+    partialTrack ?? {}
+  const { data: user } = useUser(owner_id)
+  const isPreview = !!is_stream_gated && !!preview_cid && !hasStreamAccess
 
-  const trackId = track?.track_id
   const uid = useMemo(() => {
-    return trackId ? makeUid(Kind.TRACKS, trackId) : null
-  }, [trackId])
+    return track_id ? makeUid(Kind.TRACKS, track_id) : null
+  }, [track_id])
 
   const recordAnalytics = useCallback(
     ({ name, id }: { name: TrackPlayback; id: ID }) => {
-      if (!track) return
+      if (!trackExists) return
       trackEvent(
         make({
           eventName: name,
@@ -54,19 +56,19 @@ export const ChatMessageTrack = ({
         })
       )
     },
-    [track]
+    [trackExists]
   )
 
   const { togglePlay } = useToggleTrack({
-    id: track?.track_id,
+    id: track_id,
     uid,
     isPreview,
     source: QueueSource.CHAT_TRACKS,
     recordAnalytics
   })
 
   useEffect(() => {
-    if (track && user && uid) {
+    if (trackExists && user && uid) {
       trackEvent(
         make({
           eventName: Name.MESSAGE_UNFURL_TRACK
@@ -76,11 +78,11 @@ export const ChatMessageTrack = ({
     } else {
       onEmpty?.()
     }
-  }, [track, user, uid, onSuccess, onEmpty])
+  }, [trackExists, user, uid, onSuccess, onEmpty])
 
-  return track && user && uid ? (
+  return track_id && user && uid ? (
     <TrackTile
-      id={track.track_id}
+      id={track_id}
       index={0}
       togglePlay={togglePlay}
       uid={uid}

packages/web/src/components/edit/fields/RemixSettingsField/RemixSettingsMenuFields.tsx

@@ -1,11 +1,10 @@
 import { useEffect } from 'react'
 
-import { useGetTrackByPermalink } from '@audius/common/api'
+import { useTrackByPermalink } from '@audius/common/api'
 import { useGatedContentAccess } from '@audius/common/hooks'
-import { accountSelectors } from '@audius/common/store'
 import { getPathFromTrackUrl } from '@audius/common/utils'
 import { useField } from 'formik'
-import { useSelector } from 'react-redux'
+import { pick } from 'lodash'
 import { useThrottle } from 'react-use'
 
 import { Divider } from 'components/divider'
@@ -16,7 +15,6 @@ import { SwitchRowField } from '../SwitchRowField'
 import styles from './RemixSettingsField.module.css'
 import { TrackInfo } from './TrackInfo'
 import { CAN_REMIX_PARENT, IS_REMIX, REMIX_LINK, SHOW_REMIXES } from './types'
-const { getUserId } = accountSelectors
 
 const messages = {
   hideRemix: {
@@ -36,24 +34,29 @@ export const RemixSettingsMenuFields = () => {
   const [{ value: trackUrl }] = useField(REMIX_LINK)
   const [, , { setValue: setCanRemixParent }] = useField(CAN_REMIX_PARENT)
   const permalink = useThrottle(getPathFromTrackUrl(trackUrl), 1000)
-  const currentUserId = useSelector(getUserId)
 
-  const { data: track } = useGetTrackByPermalink(
-    { permalink, currentUserId },
-    { disabled: !permalink }
-  )
+  const { data: partialTrack } = useTrackByPermalink(permalink, {
+    select: (track) =>
+      pick(track, [
+        'track_id',
+        'is_stream_gated',
+        'stream_conditions',
+        'is_download_gated',
+        'download_conditions',
+        'access'
+      ])
+  })
 
-  const trackId = track?.track_id
-  const { hasStreamAccess: canRemixParent } = useGatedContentAccess(
-    track ?? null
-  )
+  const { track_id } = partialTrack ?? {}
+  const { hasStreamAccess: canRemixParent } =
+    useGatedContentAccess(partialTrack)
 
   const [, , { setValue: setParentTrackId }] = useField('parentTrackId')
 
   useEffect(() => {
-    setParentTrackId(trackId)
+    setParentTrackId(track_id)
     setCanRemixParent(canRemixParent)
-  }, [trackId, setParentTrackId, canRemixParent, setCanRemixParent])
+  }, [track_id, setParentTrackId, canRemixParent, setCanRemixParent])
 
   return (
     <div className={styles.fields}>
@@ -63,7 +66,7 @@ export const RemixSettingsMenuFields = () => {
         description={messages.remixOf.description}
       >
         <TextField name={REMIX_LINK} label={messages.remixOf.linkLabel} />
-        {track ? <TrackInfo trackId={track.track_id} /> : null}
+        {track_id ? <TrackInfo trackId={track_id} /> : null}
       </SwitchRowField>
 
       <Divider />

packages/web/src/components/now-playing/components/ActionsBar.tsx

@@ -40,10 +40,16 @@ const ActionsBar = ({
   const { data: partialTrack } = useTrack(trackId, {
     select: (track) =>
       pick(track, [
+        'track_id',
         'is_unlisted',
         'owner_id',
         'has_current_user_reposted',
-        'has_current_user_saved'
+        'has_current_user_saved',
+        'access',
+        'is_stream_gated',
+        'stream_conditions',
+        'is_download_gated',
+        'download_conditions'
       ])
   })
   const { data: currentUserId } = useCurrentUserId()
@@ -54,7 +60,7 @@ const ActionsBar = ({
     is_unlisted: isUnlisted
   } = partialTrack ?? {}
   const isOwner = ownerId === currentUserId
-  const { hasStreamAccess } = useGatedContentAccess(partialTrack ?? {})
+  const { hasStreamAccess } = useGatedContentAccess(partialTrack)
   const shouldShowActions = hasStreamAccess && !isUnlisted
 
   if (!shouldShowActions) return null

packages/web/src/components/track/helpers.ts

@@ -45,7 +45,11 @@ export const getTrackWithFallback = (track: Track | null | undefined) => {
       ddex_app: null,
       comment_count: 0,
       comments_disabled: false,
-      album_backlink: undefined
+      album_backlink: undefined,
+      access: {
+        stream: false,
+        download: false
+      }
     }
   )
 }