[C-1678] Add metrics for offline mode in the workers (#2844)

packages/mobile/src/store/offline-downloads/sagas/downloadQueueSagas/workers/downloadCollectionWorker.ts

@@ -10,16 +10,18 @@ import RNFetchBlob from 'rn-fetch-blob'
 import { select, call, put, take, race, all } from 'typed-redux-saga'
 
 import { createAllImageSources } from 'app/hooks/useContentNodeImage'
+import { make, track } from 'app/services/analytics'
 import {
   getCollectionCoverArtPath,
   getLocalCollectionDir,
   getLocalCollectionJsonPath,
   mkdirSafe
 } from 'app/services/offline-downloader'
 import { DOWNLOAD_REASON_FAVORITES } from 'app/store/offline-downloads/constants'
+import { EventNames } from 'app/types/analytics'
 
 import { getCollectionOfflineDownloadStatus } from '../../../selectors'
-import type { CollectionId } from '../../../slice'
+import type { CollectionId, DownloadQueueItem } from '../../../slice'
 import {
   abandonDownload,
   errorDownload,
@@ -48,7 +50,14 @@ function* shouldAbortDownload(collectionId: CollectionId) {
 }
 
 export function* downloadCollectionWorker(collectionId: CollectionId) {
-  yield* put(startDownload({ type: 'collection', id: collectionId }))
+  const queueItem = {
+    type: 'collection',
+    id: collectionId
+  } as DownloadQueueItem
+  track(
+    make({ eventName: EventNames.OFFLINE_MODE_DOWNLOAD_START, ...queueItem })
+  )
+  yield* put(startDownload(queueItem))
 
   const { jobResult, cancel, abort } = yield* race({
     jobResult: call(downloadCollectionAsync, collectionId),
@@ -63,14 +72,32 @@ export function* downloadCollectionWorker(collectionId: CollectionId) {
     yield* put(cancelDownload({ type: 'collection', id: collectionId }))
     yield* call(removeDownloadedCollection, collectionId)
   } else if (jobResult === OfflineDownloadStatus.ERROR) {
+    track(
+      make({
+        eventName: EventNames.OFFLINE_MODE_DOWNLOAD_FAILURE,
+        ...queueItem
+      })
+    )
     yield* put(errorDownload({ type: 'collection', id: collectionId }))
     yield* call(removeDownloadedCollection, collectionId)
     yield* put(requestDownloadQueuedItem())
   } else if (jobResult === OfflineDownloadStatus.ABANDONED) {
+    track(
+      make({
+        eventName: EventNames.OFFLINE_MODE_DOWNLOAD_FAILURE,
+        ...queueItem
+      })
+    )
     yield* put(abandonDownload({ type: 'collection', id: collectionId }))
     yield* call(removeDownloadedCollection, collectionId)
     yield* put(requestDownloadQueuedItem())
   } else if (jobResult === OfflineDownloadStatus.SUCCESS) {
+    track(
+      make({
+        eventName: EventNames.OFFLINE_MODE_DOWNLOAD_SUCCESS,
+        ...queueItem
+      })
+    )
     yield* put(completeDownload({ type: 'collection', id: collectionId }))
     yield* put(requestDownloadQueuedItem())
   }

packages/mobile/src/store/offline-downloads/sagas/downloadQueueSagas/workers/downloadTrackWorker.ts

@@ -11,14 +11,17 @@ import RNFetchBlob from 'rn-fetch-blob'
 import { select, call, put, all, take, race } from 'typed-redux-saga'
 
 import { createAllImageSources } from 'app/hooks/useContentNodeImage'
+import { make, track } from 'app/services/analytics'
 import {
   getLocalAudioPath,
   getLocalTrackCoverArtDestination,
   getLocalTrackDir,
   getLocalTrackJsonPath
 } from 'app/services/offline-downloader'
+import { EventNames } from 'app/types/analytics'
 
 import { getTrackOfflineDownloadStatus } from '../../../selectors'
+import type { DownloadQueueItem } from '../../../slice'
 import {
   cancelDownload,
   completeDownload,
@@ -45,7 +48,11 @@ function* shouldAbortDownload(trackId: ID) {
 }
 
 export function* downloadTrackWorker(trackId: ID) {
-  yield* put(startDownload({ type: 'track', id: trackId }))
+  const queueItem = { type: 'track', id: trackId } as DownloadQueueItem
+  track(
+    make({ eventName: EventNames.OFFLINE_MODE_DOWNLOAD_START, ...queueItem })
+  )
+  yield* put(startDownload(queueItem))
 
   const { jobResult, cancel, abort } = yield* race({
     jobResult: call(downloadTrackAsync, trackId),
@@ -60,14 +67,32 @@ export function* downloadTrackWorker(trackId: ID) {
     yield* put(cancelDownload({ type: 'track', id: trackId }))
     yield* call(removeDownloadedTrack, trackId)
   } else if (jobResult === OfflineDownloadStatus.ERROR) {
+    track(
+      make({
+        eventName: EventNames.OFFLINE_MODE_DOWNLOAD_FAILURE,
+        ...queueItem
+      })
+    )
     yield* put(errorDownload({ type: 'track', id: trackId }))
     yield* call(removeDownloadedTrack, trackId)
     yield* put(requestDownloadQueuedItem())
   } else if (jobResult === OfflineDownloadStatus.ABANDONED) {
+    track(
+      make({
+        eventName: EventNames.OFFLINE_MODE_DOWNLOAD_FAILURE,
+        ...queueItem
+      })
+    )
     yield* put(abandonDownload({ type: 'track', id: trackId }))
     yield* call(removeDownloadedTrack, trackId)
     yield* put(requestDownloadQueuedItem())
   } else if (jobResult === OfflineDownloadStatus.SUCCESS) {
+    track(
+      make({
+        eventName: EventNames.OFFLINE_MODE_DOWNLOAD_SUCCESS,
+        ...queueItem
+      })
+    )
     yield* put(
       completeDownload({ type: 'track', id: trackId, completedAt: Date.now() })
     )

packages/mobile/src/store/offline-downloads/sagas/downloadQueueSagas/workers/playCounterWorker.ts

@@ -2,11 +2,15 @@ import type { ID } from '@audius/common'
 import { tracksSocialActions } from '@audius/common'
 import { put } from 'typed-redux-saga'
 
+import { make, track } from 'app/services/analytics'
+import { EventNames } from 'app/types/analytics'
+
 import { completePlayCount, requestDownloadQueuedItem } from '../../../slice'
 
 const { recordListen } = tracksSocialActions
 
 export function* playCounterWorker(trackId: ID) {
+  track(make({ eventName: EventNames.OFFLINE_MODE_PLAY, trackId }))
   yield* put(recordListen(trackId))
   yield* put(completePlayCount())
   yield* put(requestDownloadQueuedItem())

packages/mobile/src/store/offline-downloads/sagas/requestDownloadAllFavoritesSaga.ts

@@ -7,7 +7,9 @@ import moment from 'moment'
 import { takeEvery, select, call, put } from 'typed-redux-saga'
 
 import { getAccountCollections } from 'app/screens/favorites-screen/selectors'
+import { make, track } from 'app/services/analytics'
 import { DOWNLOAD_REASON_FAVORITES } from 'app/store/offline-downloads/constants'
+import { EventNames } from 'app/types/analytics'
 
 import type { OfflineItem } from '../slice'
 import { addOfflineItems, requestDownloadAllFavorites } from '../slice'
@@ -21,6 +23,11 @@ export function* requestDownloadAllFavoritesSaga() {
 }
 
 function* downloadAllFavorites() {
+  track(
+    make({
+      eventName: EventNames.OFFLINE_MODE_DOWNLOAD_ALL_TOGGLE_ON
+    })
+  )
   const currentUserId = yield* select(getUserId)
   if (!currentUserId) return
 

packages/mobile/src/store/offline-downloads/sagas/requestDownloadCollectionSaga.ts

@@ -6,6 +6,9 @@ import {
 } from '@audius/common'
 import { takeEvery, select, put, call } from 'typed-redux-saga'
 
+import { make, track } from 'app/services/analytics'
+import { EventNames } from 'app/types/analytics'
+
 import type { CollectionAction, OfflineItem } from '../slice'
 import { addOfflineItems, requestDownloadCollection } from '../slice'
 
@@ -19,6 +22,12 @@ export function* requestDownloadCollectionSaga() {
 
 function* downloadCollection(action: CollectionAction) {
   const { collectionId } = action.payload
+  track(
+    make({
+      eventName: EventNames.OFFLINE_MODE_DOWNLOAD_COLLECTION_TOGGLE_ON,
+      collectionId
+    })
+  )
 
   const currentUserId = yield* select(getUserId)
   if (!currentUserId) return

packages/mobile/src/store/offline-downloads/sagas/requestRemoveAllDownloadedFavoritesSaga.ts

@@ -1,6 +1,8 @@
 import { takeEvery, select, put } from 'typed-redux-saga'
 
+import { make, track } from 'app/services/analytics'
 import { DOWNLOAD_REASON_FAVORITES } from 'app/store/offline-downloads/constants'
+import { EventNames } from 'app/types/analytics'
 
 import {
   getOfflineCollectionMetadata,
@@ -25,6 +27,11 @@ export function* requestRemoveAllDownloadedFavoritesSaga() {
 }
 
 function* removeAllDownloadedFavoritesWorker() {
+  track(
+    make({
+      eventName: EventNames.OFFLINE_MODE_DOWNLOAD_ALL_TOGGLE_OFF
+    })
+  )
   const offlineItemsToRemove: OfflineItem[] = []
   const offlineCollectionMetadata = yield* select(getOfflineCollectionMetadata)
   const offlineCollectionIds = Object.keys(offlineCollectionMetadata).map(

packages/mobile/src/store/offline-downloads/sagas/requestRemoveDownloadedCollectionSaga.ts

@@ -1,5 +1,8 @@
 import { takeEvery, select, put } from 'typed-redux-saga'
 
+import { make, track } from 'app/services/analytics'
+import { EventNames } from 'app/types/analytics'
+
 import { getOfflineTrackMetadata } from '../selectors'
 import type { CollectionAction, OfflineItem } from '../slice'
 import { removeOfflineItems, requestRemoveDownloadedCollection } from '../slice'
@@ -13,6 +16,12 @@ export function* requestRemoveDownloadedCollectionSaga() {
 
 function* removeDownloadedCollectionWorker(action: CollectionAction) {
   const { collectionId } = action.payload
+  track(
+    make({
+      eventName: EventNames.OFFLINE_MODE_DOWNLOAD_COLLECTION_TOGGLE_OFF,
+      collectionId
+    })
+  )
 
   const offlineItemsToRemove: OfflineItem[] = []
 

packages/mobile/src/store/offline-downloads/sagas/watchRemoveOfflineItems.ts

@@ -1,10 +1,12 @@
 import RNFetchBlob from 'rn-fetch-blob'
 import { takeEvery, select, call } from 'typed-redux-saga'
 
+import { make, track } from 'app/services/analytics'
 import {
   getLocalCollectionDir,
   getLocalTrackDir
 } from 'app/services/offline-downloader'
+import { EventNames } from 'app/types/analytics'
 
 import {
   getOfflineCollectionsStatus,
@@ -23,6 +25,12 @@ function* deleteItemsFromDisk(action: RemoveOfflineItemsAction) {
   const collectionStatus = yield* select(getOfflineCollectionsStatus)
 
   for (const item of items) {
+    track(
+      make({
+        eventName: EventNames.OFFLINE_MODE_REMOVE_ITEM,
+        ...item
+      })
+    )
     if (item.type === 'collection' && !collectionStatus[item.id]) {
       const collectionDirectory = yield* call(
         getLocalCollectionDir,

packages/mobile/src/store/offline-downloads/sagas/watchSaveCollectionSaga.ts

@@ -1,6 +1,9 @@
 import { collectionsSocialActions, FavoriteSource } from '@audius/common'
 import { takeEvery, select, put } from 'typed-redux-saga'
 
+import { make, track } from 'app/services/analytics'
+import { EventNames } from 'app/types/analytics'
+
 import { getIsFavoritesDownloadsEnabled } from '../selectors'
 import { requestDownloadFavoritedCollection } from '../slice'
 
@@ -19,6 +22,13 @@ function* checkIfShouldDownload(action: ReturnType<typeof saveCollection>) {
     isFavoritesDownloadEnabled &&
     source !== FavoriteSource.OFFLINE_DOWNLOAD
   ) {
+    track(
+      make({
+        eventName: EventNames.OFFLINE_MODE_DOWNLOAD_REQUEST,
+        type: 'collection',
+        id: collectionId
+      })
+    )
     yield* put(requestDownloadFavoritedCollection({ collectionId }))
   }
 }

packages/mobile/src/store/offline-downloads/sagas/watchSaveTrackSaga.ts

@@ -2,7 +2,9 @@ import { tracksSocialActions } from '@audius/common'
 import moment from 'moment'
 import { put, takeEvery, select } from 'typed-redux-saga'
 
+import { make, track } from 'app/services/analytics'
 import { DOWNLOAD_REASON_FAVORITES } from 'app/store/offline-downloads/constants'
+import { EventNames } from 'app/types/analytics'
 
 import { getIsFavoritesDownloadsEnabled } from '../selectors'
 import { addOfflineItems } from '../slice'
@@ -20,6 +22,13 @@ function* downloadSavedTrack(
   )
 
   if (isFavoritesDownloadEnabled) {
+    track(
+      make({
+        eventName: EventNames.OFFLINE_MODE_DOWNLOAD_REQUEST,
+        type: 'track',
+        id: trackId
+      })
+    )
     yield* put(
       addOfflineItems({
         items: [

packages/mobile/src/store/offline-downloads/slice.ts

@@ -277,19 +277,19 @@ const slice = createSlice({
       }
     },
     completeDownload: (state, action: CompleteDownloadAction) => {
-      const item = action.payload
-      if (item.type === 'collection') {
-        state.collectionStatus[item.id] = OfflineDownloadStatus.SUCCESS
-      } else if (item.type === 'track') {
-        const { id, completedAt } = item
+      const { type, id } = action.payload
+      if (type === 'collection') {
+        state.collectionStatus[id] = OfflineDownloadStatus.SUCCESS
+      } else if (type === 'track') {
+        const { completedAt } = action.payload
         state.trackStatus[id] = OfflineDownloadStatus.SUCCESS
         const trackMetadata = state.offlineTrackMetadata[id]
         if (trackMetadata) {
           trackMetadata.last_verified_time = completedAt
           trackMetadata.download_completed_time = completedAt
         }
-      } else if (item.type === 'stale-track') {
-        const { id, verifiedAt } = item
+      } else if (type === 'stale-track') {
+        const { verifiedAt } = action.payload
         const trackMetadata = state.offlineTrackMetadata[id]
         if (trackMetadata) {
           trackMetadata.last_verified_time = verifiedAt