Allow fetching by permalink on client desktop by sabrina-kiam · Pull Request #2610 · AudiusProject/audius-client

sabrina-kiam · 2023-01-18T17:45:09Z

Description

This diff adds permalinks across the frontend. These changes should be backwards compatible except for the last one which is commented out. It covers:

Adding to the collections cache a map of permalinks to playlist id's
Adding to the collection store a permalink object which tracks the permalink
Updating audius api client to call the new route getPlaylistByPermalink
Adding a retrieveCollectionByPermalink function to retrieveCollections which gets called whenever we fetch a collection (if permalink exists)
Updated routing for matching a path to our new permalink path containing a slug and handle. This is commented out for now as this change is not backwards compatible.

What remains on client side:

Gating the routing and fetching behind a feature flag
Updating mobile stuff which Dylan is working on
Updating PLAYLIST_PAGE() routing calls to take in a handle and slug

Dragons

There are a lot of changes that could easily mess up playlists somehow so want to make sure we're extra thorough with QA-ing playlist behavior and just ensuring current behavior hasn't changed.

How Has This Been Tested?

Ran client against staging. I tested a lot of existing behavior to make sure nothing crashed:

creating a playlist
adding a song to playlist
fetching an uncached playlist
fetching a cached playlist

How will this change be monitored?

Feature Flags

Will want to add feature flags!

…vail

audius-infra · 2023-01-18T20:05:16Z

Preview this change https://demo.audius.co/sk-pr-clean

dylanjeffers

awesome work on this!!!

dylanjeffers · 2023-01-18T21:48:24Z

+        'Permalink formatted incorrectly. Should follow /<handle>/playlist/<slug> format.'
+      )
+    }
+    const handle = splitPermalink[1]


just a thought, you could do something fancy like

const [_audiusUrl, handle, _playlist, slug] = splitPermalink

or maybe even

const [, handle, , slug] = splitPermalink

ooo fancy i like, will add

dylanjeffers · 2023-01-18T21:49:37Z

+    return {
+      ...state,
+      permalinks: {
+        // @ts-ignore


just want to double check we want to ts-ignore this?

dylanjeffers · 2023-01-18T22:03:34Z

-        this.props.fetchCollection(collectionId as number)
+
+    if (params?.collectionId) {
+      if (forceFetch || params?.collectionId !== this.state.playlistId) {


ultra nit, params.collectionId since if branch ensures it's there few other cases down below too. personally, once ive established existance in an object, and its reffed multple times, i desturcture it,

if (params.?collectionId) { const {collectionId} = params ...

dylanjeffers · 2023-01-18T22:05:04Z

+      }
+    }
+
+    if (params?.permalink) {


do we also need collectionId to be here?

dylanjeffers · 2023-01-18T22:05:45Z

    return { collectionId, handle: null, collectionType: null, title: null }
  }

+  // const playlistByPermalinkMatch = matchPath<{


gitguardian · 2023-01-20T22:39:05Z

⚠️ GitGuardian has uncovered 2 secrets following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secrets in your pull request

GitGuardian id	Secret	Commit	Filename
688750	Generic High Entropy Secret	`0b7d0ae`	packages/mobile/.env.stage	View secret
2416684	Generic High Entropy Secret	`0b7d0ae`	packages/mobile/.env.stage	View secret

🛠 Guidelines to remediate hardcoded secrets

Understand the implications of revoking this secret by investigating where it is used in your code.
Replace and store your secrets safely. Learn here the best practices.
Revoke and rotate these secrets.
If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.

To avoid such incidents in the future consider

following these best practices for managing and storing secrets including API keys and other credentials
install secret detection on pre-commit to catch secret before it leaves your machine and ease remediation.

^{🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.

Our GitHub checks need improvements? Share your feedbacks!}

audius-infra · 2023-01-20T23:20:44Z

Preview this change https://demo.audius.co/sk-pr-clean

[47b0ed1] Fix lineups not loading in Offline Mode (C-1945, C-1882, C-1803) (#2697) nicoback2 [da8637f] Add toggle for message notifs on web + mobile (#2700) Michelle Brier [f909c82] Remove use of iso3 country code (#2719) Reed [48ce610] Change location.in_eu to is_eu (#2718) Reed [a0fa651] [DMs] Update DMs store, sagas and selectors to be optimistic (#2711) Marcus Pasell [d62bc36] Fix popup menu on nav (#2717) Marcus Pasell [5b5e5ae] [C-1969 C-1967] Don't re-favorite playlist on download (#2713) Dylan Jeffers [1c02211] Port Input Component to Typescript - InputV2 (#2714) Marcus Pasell [5e6a8b8] [DMs] Show the name of the user that reacted when hovering over a reaction (#2587) Marcus Pasell [731539d] [C-1754] Fix modal popups not closing (#2691) Marcus Pasell [9f53712] Fix incorrect type for follower group in profile (#2705) Marcus Pasell [a664ba3] Update TextAreaV2 to respect initial height when non-growing (#2703) Marcus Pasell [75e9243] [DMs] Fix plus button not appearing on own messages (#2712) Marcus Pasell [f58e3fb] Change react-native-job-queue updateInterval to 500 ms (#2710) Sebastian Klingler [6d174ed] Update PopupMenu to not have circular icons (#2704) Marcus Pasell [613d992] [C-1891] Restart app on saga error, Refactor mobile toasts (#2696) Dylan Jeffers [a1293c6] Fix profile picture crash (#2698) Raymond Jacobson [3316525] Use 2-letter country codes in buy-audio location (#2695) Reed [e773823] Improve offline mode react performance (#2694) Sebastian Klingler [34c46c2] [PAY-878] Wrap getBalance in try/catch (#2692) Reed [067f249] Fix button alignment in rewards tiles (#2693) Reed [5b11226] Performance improvements for offline mode (#2690) Andrew Mendelsohn [778640f] Revert "Make rc-staging fast-app variant (#2585)" (#2689) Raymond Jacobson [6f24d1b] [C-1907, C-1928] Update chromecast icon in NowPlayingDrawer and track name length on track list items (#2688) Kyle Shanks [ef58833] C-1932 Hide playlists in offline mode with no downloaded tracks (#2686) nicoback2 [2d5a7cd] Fix content alignment in rewards tiles (#2687) Reed [16833c7] Remove ButtonWithArrow (#2682) Reed [8d88e1d] [PAY-871] Extend reward buttons to full tile width (#2683) Reed [82f5a9b] C-1908 Show error indicator on playlists if all track downloads failed (#2681) nicoback2 [70bb4de] Fix mobile error (#2685) nicoback2 [7d8b7aa] [DMs] Set max length of the composer to 10k (#2673) Marcus Pasell [084f23d] Install react-native-tiktok with patch (#2659) nicoback2 [70598db] Add queue length checks when skipping using the track player (#2675) Kyle Shanks [284b5c7] DMs: Add compose button (#2666) Marcus Pasell [c72fbba] [DMs] Add tails to chat bubbles (#2653) Marcus Pasell [f16eeb4] [DMs] Fix pagination for chat list and chat message list (#2652) Marcus Pasell [fd84793] Fix rewards claim button for aggregate challenges (#2671) Reed [2ecb9f5] Fix artwork for now-playing and playbar (#2674) Dylan Jeffers [604566e] [C-1884] Improve top supporters fetching and loading (#2651) Dylan Jeffers [c735486] Update SDK to 1.0.42 (#2668) Marcus Pasell [2654459] [C-1854] Prevent crash on settings page (#2667) Sebastian Klingler [df5e524] Listen to add succeeded (#2669) Saliou Diallo [55c4b64] [PAY-862] Rewards UI Improvements Followups (#2662) Reed [0ae57f7] [C-1894] [C-1904] Fix tiktok verification (#2665) Sebastian Klingler [21fb1a6] Fix profile (#2664) Saliou Diallo [8b8d350] Fix playlist tile click (#2663) Saliou Diallo [0d6a949] [C-1885] Improve user socials fetching/loading (#2650) Dylan Jeffers [9213f8f] [PAY-853] Premium content fixes on web (#2642) Saliou Diallo [c204e1b] Memoize sorted challenges (#2649) Reed [f7bfce0] [C-1874] Improve lineup loading animations, add fast-image (#2648) Dylan Jeffers [b7bd8bb] [C-1669] Enable OFFLINE_MODE_ENABLED feature flag (#2658) Andrew Mendelsohn [2601207] [C-1881] Allow removing downloads while offline (#2657) Andrew Mendelsohn [3a5f98c] [C-1879] Download track when added to downloaded playlists (#2656) Andrew Mendelsohn [d3de906] [C-1875] Fix empty favorited tracks lineup on reconnect (#2655) Andrew Mendelsohn [1ca06c1] Add explicit sizing to image fetching (#2566) Sebastian Klingler [66a56ea] [C-1876] Hide download indicator on deleted tracks (#2654) Sebastian Klingler [f78d1eb] Allow fetching by permalink on client desktop (#2610) sabrina-kiam

sabrina added 11 commits January 17, 2023 02:36

Update pages collection store

0be2c22

update collection route parser and collection page provider

9dc5e6f

add collections cache with permalinks

5c07bc2

add permalinks to cache in cache collections saga

d8dea12

update audius api client with endpoint for get playlist by permalink

d7bcbe2

add retrieveCollectionsByPermalink util fn

624cb82

add retrieveCollectionByPermalink and add call to saga if permalink a…

fb1b415

…vail

fix audius api client route

c899a94

fix permalink parsing in audius api client

75af6bd

return collections in getCollections cache selector

c0e7b01

rm export on CacheState type

a602c51

sabrina-kiam requested a review from dylanjeffers January 18, 2023 17:45

pull-request-size Bot added the size/L label Jan 18, 2023

sabrina added 3 commits January 18, 2023 12:58

fix or ignore type errors

a5a7ecd

fix typing in retrieveCollections and change args for retrieveCollection

5066525

fix reduce ts error

33ed3c1

dylanjeffers approved these changes Jan 18, 2023

View reviewed changes

sabrina added 2 commits January 20, 2023 17:36

fixes based on feedback

31c2cc9

Merge remote-tracking branch 'origin/main' into sk-pr-clean

0b7d0ae

Merge branch 'main' into sk-pr-clean

f1d5340

sabrina-kiam merged commit f78d1eb into main Jan 21, 2023

sabrina-kiam deleted the sk-pr-clean branch January 21, 2023 22:15

Uh oh!

Conversation

sabrina-kiam commented Jan 18, 2023

Description

Dragons

How Has This Been Tested?

How will this change be monitored?

Feature Flags

Uh oh!

audius-infra commented Jan 18, 2023

Uh oh!

dylanjeffers left a comment

Choose a reason for hiding this comment

Uh oh!

dylanjeffers Jan 18, 2023

Choose a reason for hiding this comment

Uh oh!

sabrina-kiam Jan 19, 2023

Choose a reason for hiding this comment

Uh oh!

dylanjeffers Jan 18, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dylanjeffers Jan 18, 2023

Choose a reason for hiding this comment

Uh oh!

dylanjeffers Jan 18, 2023

Choose a reason for hiding this comment

Uh oh!

dylanjeffers Jan 18, 2023

Choose a reason for hiding this comment

Uh oh!

gitguardian Bot commented Jan 20, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ GitGuardian has uncovered 2 secrets following the scan of your pull request.

Uh oh!

audius-infra commented Jan 20, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

gitguardian Bot commented Jan 20, 2023 •

edited

Loading