[PAY-2766] Analytics events for premium albums #8262

DejayJD · 2024-04-29T18:01:31Z

Description

My aim was to provide details supporting these dashboards:

Premium album upload count
- No added metrics, in metabase we can query using existing upload success event & collection ID
Premium album edits
- New metrics added
Premium modal opens & where they are coming from
- Expanded metrics
Premium album purchases
- No added metrics, in metabase we can query using existing purchase event & collection ID
Track added to premium album
- No added metrics, in metabase we can query using existing 'added to collection' event & collection ID

Various analytics changes events related to premium albums

Added events for collection edit & one specifically for tracking access changes
Greatly expanded the premium modal source type, previously was using track tile for a ton of stuff
- DMs now have a separate event for tracks & collections
- Lineup now has a separate event for tracks & collections
- Tracks in a list item view has it's own source (i.e. for the tables in collectinos)
Added logic for unlocking

How Has This Been Tested?

web:stage

Verified that all the new events are triggered as expected

changeset-bot · 2024-04-29T18:01:34Z

⚠️ No Changeset found

Latest commit: 82e181a

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

amendelsohn

Very comprehensive! Well done

packages/common/src/models/Analytics.ts

packages/web/src/components/edit-playlist/desktop/EditPlaylistModal.tsx

amendelsohn · 2024-04-29T18:43:32Z

packages/web/src/components/edit-playlist/mobile/EditPlaylistPage.tsx

+          eventName: Name.COLLECTION_EDIT,
+          properties: {
+            id: metadata.playlist_id,
+            to: formFields


I can see how this data is useful, though I'm wondering if it makes sense to write every metadata update to our tracking service. It feels like that might be overkill or a lot of data over time. Tbh I'm unsure how the costs scale here, so will defer to those who do.

audius-infra · 2024-04-29T22:54:02Z

Preview this change https://demo.audius.co/jd/premium-album-analytics

dharit-tan · 2024-04-30T15:29:30Z

packages/web/src/components/create-playlist/PlaylistForm.tsx

-      }}
-      onSubmit={onSave}
+      initialValues={initialValues}
+      onSubmit={(values) => onSave(values, initialValues)}


super nit but this could be a useCallback. but maybe not worth.

dharit-tan · 2024-04-30T15:30:45Z

packages/web/src/components/edit-playlist/desktop/EditPlaylistModal.tsx

      if (playlistId) {
-        dispatch(editPlaylist(playlistId, formFields))
+        // Make what things changed


nit: "Calculate which metadata fields changed"

dharit-tan · 2024-04-30T15:32:05Z

packages/web/src/components/edit-playlist/desktop/EditPlaylistModal.tsx

+        const metadataChanges = omitBy(formFields, (value, key) =>
+          isEqual(value, initialValues[key])
+        ) as Partial<PlaylistFormValues>
+        track({


echoing what andrew said, do we need to track every metadata update for playlists? is this something we do for track edit? if not i might say not worth, and just collect the access changes like you're doing below.

Yeah I think thats fair. We can defer to later if we want to track any specific changes, I'll omit the metadat for now

dharit-tan · 2024-04-30T15:32:59Z

packages/web/src/components/track/GatedContentSection.tsx

-  buttonClassName
+  buttonClassName,
+  source: premiumModalSource,
+  ...other


nit: are we using other? can just omit if not.

Ah yeah I was using it to debug

dharit-tan · 2024-04-30T15:33:25Z

packages/web/src/components/track/GatedContentSection.tsx

@@ -139,26 +142,29 @@ const LockedGatedContentSection = ({
    }
    openPremiumContentPurchaseModal(
      { contentId, contentType },
-      { source: ModalSource.TrackDetails }
+      { source: premiumModalSource ?? ModalSource.TrackDetails }


dharit-tan · 2024-04-30T15:36:44Z

packages/web/src/pages/collection-page/CollectionPageProvider.tsx

+    openPremiumContentPurchaseModal: (
+      args: PremiumContentPurchaseModalState & { source: ModalSource }
+    ) => {
+      // Since we cant use the premium modal hook we have to manually trigger the modal action & the analytics tracking call


don't quite understand this, don't we have modal analytics baked in already? are you doing this specifically to get source to be tracked?

its baked into the hook, not in the action itself. Since this is a class component we don't get the baked in analytics 😞

dharit-tan

ty for doing this!

audius-infra · 2024-04-30T16:02:22Z

Preview this change https://demo.audius.co/jd/premium-album-analytics

[9f44712] Reapply "Convert swagger.json to OAS 3.0 before generating SDK types (#8274)" (#8324) (#8344) Marcus Pasell [2ea74f3] Fix issues with text-link variant (#8343) Dylan Jeffers [f005b25] [PAY-2860] SDK Services Config - Configure SDK using environment (#8329) Marcus Pasell [11a0813] Disable add to playlist for prem tracks if not purchased (#8336) Reed [33b1916] [C-4335] Migrate all user and collection cards (#8338) Dylan Jeffers [dafaa21] [QA-1241] Fix hidden track add to playlist allowing non hidden items (#8340) JD Francis [4c95031] [QA-956] Add deleted tile for tracks/albums/playlists (#8333) JD Francis [b8f5990] Add error message to upload flow (#8334) JD Francis [22894e8] [QA-957] Fix android overflowing text on access & sale modal (#8313) JD Francis [86f6447] [PAY-2812] Change spend to earn challenge copy (#8332) Reed [d4c4264] Close modal on done (#8331) Saliou Diallo [ded4933] [PAY-2861] CollectionCard fixes (#8330) Dylan Jeffers [36277cd] Revert "Convert swagger.json to OAS 3.0 before generating SDK types (#8274)" (#8324) Marcus Pasell [146b2e0] [QA-1212] Fix chromecast (#8323) Raymond Jacobson [0b33e68] [PAY-2738] Public album with prem track always shows buy button (#8321) Reed [d897a98] [C-4333] Migrate follow-users to new sign-up flow (#8312) Dylan Jeffers [3129a3a] [PAY-2799] Show preview button for collections (#8271) Reed [8c58601] Modify /etc/hosts on CI machines before api test (#8319) Danny [3586f41] [PAY-2859] Fix bugs in edit app flow (#8320) Raymond Jacobson [1bf3e97] [PAY-2801] Purchased selectable filter in library albums (#8318) Reed [6db35c6] [C-4285] Add claim all rewards button functionality (#8292) Saliou Diallo [a20d85a] [PAY-2728] Implement edit app flow (#8256) Raymond Jacobson [714a3d1] [C-4288] Migrate to new cards in profile, search, and library (#8300) Dylan Jeffers [4dceb61] Upgrade dapp-store to 0.8.1 (#8311) Dylan Jeffers [4d37233] [PAY-2794] Use UserLink for purchases/sales tables (#8306) Reed [fc2aef3] [PAY-2772] Fix collection description text size (#8309) Reed [c35bfe1] [PAY-2822] Convert LockedContentDetailsTile to Harmony (#8308) Reed [f7a921e] [PAY-2781] Poll for track access on album purchase (#8296) Reed [621c3ee] Convert swagger.json to OAS 3.0 before generating SDK types (#8274) Marcus Pasell [09789c1] Retrigger logic for android notification permissions post-manifest fix (#8305) JD Francis [b9c042a] [PAY-2815] Show unlocked icon if dm content is purchased (#8303) Andrew Mendelsohn [722e933] [PAY-2779] Fix validation for albumTrackPrice (#8302) Andrew Mendelsohn [963bec4] Fix EditCollection playwright test (#8304) Andrew Mendelsohn [7e0aa7e] [PAY-2823] Edit Album access control fixes (#8298) Andrew Mendelsohn [b42b6fd] [QA-971] Fix smart collections (#8299) Raymond Jacobson [eceb876] [PAY-2791] Show only own albums in artist dashboard (#8297) Reed [87ce027] [Web] [Harmony] Add accounts managing you modal [C-4295] [C-4292] (#8258) nicoback2 [7a3567c] [C-4238, C-4318] Add ssr small bundle flow for mobile track page (#8293) Kyle Shanks [c7c3752] [PAY-2800] Fix mobile navigate to album on purchase success (#8295) Reed [f113a91] [PAY-2802] Auto-favorite tracks in purchased album (#8294) Reed [d32934f] [C-4284] Fix rewards in mobile web (#8291) Saliou Diallo [45c4bc6] [PAY-2775] Remove suggested tracks for albums (#8288) Andrew Mendelsohn [22280c6] [C-4080] Mobile cooldown and claim all (#8263) Isaac Solo [80cca19] Jail broken test (#8289) Raymond Jacobson [d7c8e34] [PAY-2766] Analytics events for premium albums (#8262) JD Francis [c3ee4a8] [PAY-2817] Web collections show reposts, remove artist column (#8272) Reed [6f8bab6] Fix lint items (#8285) Raymond Jacobson [e8debc0] [PAY-2703] Redesign mobile collection and track screen tiles (#8255) Andrew Mendelsohn [a3964a8] Bump android build number for release-client-v1.5.78 (#8286) Raymond Jacobson [8481f8d] [C-4327] Fix track ordering within playlist/album (#8284) Raymond Jacobson [5165172] Bump android version for manifest changes (#8283) JD Francis [4e60f97] [C-4312] Add UserCard (#8276) Dylan Jeffers [35ed4ec] [ONC-82] Fix android notif permissions (#8279) JD Francis [82e1c67] [C-4323] Improve Avatar (#8273) Dylan Jeffers [909db7c] [C-4316, C-4317] SSR work to render webplayer and track page for web (#8268) Kyle Shanks [7417a40] Generate sdk after ursm code removal (#8275) Raymond Jacobson [62b5a08] Update Add Funds copy and loading state (#8266) Saliou Diallo [4503cc7] PROTO-1328: always default to discovery relay (#8247) alecsavvy [f42c6cd] Fix text-input spacing (#8270) Dylan Jeffers [75fd847] [C-4270] Fix text-link transition (#8260) Dylan Jeffers [df0349a] [PAY-2761] Add managed users endpoints (#8238) Randy Schott [5b4c998] [ONC-84] Add try/catch (#8264) Raymond Jacobson [2b5f89c] Fix clipped text in TracksTable name column (#8265) Reed [c3256fa] [C-4275] Add google-inspectiontool to crawler regex (#8261) Sebastian Klingler [5750045] [C-4033] Prevent useTabs from redirecting on page load (#8259) Sebastian Klingler [b17ff70] [PAY-2758] Allow gated tracks to be added to playlists (#8227) Reed

Add various analytics events for better tracking

ac7f578

DejayJD requested a review from amendelsohn April 29, 2024 18:01

pull-request-size bot added the size/L label Apr 29, 2024

DejayJD requested a review from dharit-tan April 29, 2024 18:01

amendelsohn approved these changes Apr 29, 2024

View reviewed changes

DejayJD added 5 commits April 29, 2024 14:18

TS fixes

54bb348

fix TS

d4a394b

lint

6dc42d6

tweak

fd57cda

lint

d4c4e1b

dharit-tan reviewed Apr 30, 2024

View reviewed changes

dharit-tan approved these changes Apr 30, 2024

View reviewed changes

DejayJD added 2 commits April 30, 2024 10:45

feedback

174e4c3

put plain edit event back

82e181a

DejayJD merged commit d7c8e34 into main May 1, 2024
20 of 22 checks passed

DejayJD deleted the jd/premium-album-analytics branch May 1, 2024 16:01

DejayJD mentioned this pull request May 17, 2024

[PAY-2767] Premium albums mobile analytics #8549

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[PAY-2766] Analytics events for premium albums #8262

[PAY-2766] Analytics events for premium albums #8262

DejayJD commented Apr 29, 2024

changeset-bot bot commented Apr 29, 2024 •

edited

amendelsohn left a comment

amendelsohn Apr 29, 2024

audius-infra commented Apr 29, 2024

dharit-tan Apr 30, 2024

dharit-tan Apr 30, 2024

dharit-tan Apr 30, 2024

DejayJD Apr 30, 2024 •

edited

dharit-tan Apr 30, 2024

DejayJD Apr 30, 2024

dharit-tan Apr 30, 2024

dharit-tan Apr 30, 2024

DejayJD Apr 30, 2024

dharit-tan left a comment

audius-infra commented Apr 30, 2024

[PAY-2766] Analytics events for premium albums #8262

[PAY-2766] Analytics events for premium albums #8262

Conversation

DejayJD commented Apr 29, 2024

Description

How Has This Been Tested?

changeset-bot bot commented Apr 29, 2024 • edited

⚠️ No Changeset found

amendelsohn left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

audius-infra commented Apr 29, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DejayJD Apr 30, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dharit-tan left a comment

Choose a reason for hiding this comment

audius-infra commented Apr 30, 2024

changeset-bot bot commented Apr 29, 2024 •

edited

DejayJD Apr 30, 2024 •

edited