Convert AudiusBackend to typescript by sliptype · Pull Request #1650 · AudiusProject/audius-client

sliptype · 2022-07-26T22:31:07Z

Description

Converts AudiusBackend.js to TypeScript

Used the typed DiscoveryApi to specify argument types on many of the functions. This is with the help of pretty crazy SnakeKeysToCamel type helper.

Most of this extra layer will probably be removed eventually in favor of using the sdk, but types will help in the refactoring process

Dragons

Is there anything the reviewer should be on the lookout for? Are there any dangerous changes?

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide repro instructions & any configuration.

How will this change be monitored?

For features that are critical or could fail silently please describe the monitoring/alerting being added.

Feature Flags

Are all new features properly feature flagged? Describe added feature flags.

audius-infra · 2022-07-26T22:42:39Z

Preview this change https://demo.audius.co/sk-audius-backend-port

audius-infra · 2022-07-27T17:57:12Z

Preview this change https://demo.audius.co/sk-audius-backend-port

audius-infra · 2022-07-27T18:11:50Z

Preview this change https://demo.audius.co/sk-audius-backend-port

dylanjeffers

dope work

dylanjeffers · 2022-07-27T18:05:07Z

-const addTrackImages = <T extends TrackMetadata>(
-  track: T
-): T & { duration: number; _cover_art_sizes: CoverArtSizes } => {
+const addTrackImages = (


nice simplifications

dylanjeffers · 2022-07-27T18:05:30Z

 function* fetchDashboardListenDataAsync(action) {
  const listenData = yield call(
    AudiusBackend.getTrackListens,
+    action.period,


wow.. nice find

dylanjeffers · 2022-07-27T18:06:30Z

        userId: currentUser.user_id,
        handle: currentUser.handle,
-        recipientEthAddress: currentUser.wallet,
+        recipientEthAddress: currentUser.wallet as string,


just checking we dont want an if statement to check that case wallet, endpoints, and parallelization are not around?

Yeah actually I think I can add it to the null check above

dylanjeffers · 2022-07-27T18:07:57Z

  try {
    yield call(waitForBackendSetup)
-    const accountUserId: Nullable<ID> = yield select(getUserId)
+    const accountUserId: ID = yield select(getUserId)


can we yield* these or would that take too long? from what i remember this actually is a Nullable<ID>

yeah just tried it and after changing 'redux-saga/effects' import to 'typed-redux-saga/macro', this logic works:

const accountUserId = yield* select(getUserId) const userMetadata = yield* select(getAccountUser) if (!accountUserId || !userMetadata) return yield put( requestConfirmation( DEACTIVATE_CONFIRMATION_UID, ...

Sick ok will do that instead

dylanjeffers · 2022-07-27T18:11:28Z

          const { blockHash, blockNumber } = yield call(
            AudiusBackend.updateCreator,
-            { ...userMetadata, is_deactivated: true },
+            { ...userMetadata, is_deactivated: true } as User,


(and wont need to cast here)

dylanjeffers · 2022-07-27T18:30:17Z

-    return feedItems.map((item) => {
-      if (item.playlist_id) return AudiusBackend.getCollectionImages(item)
+    return feedItems.map((item: Collection | Track) => {
+      if ((item as Collection).playlist_id) {


i think you can do if ('playlist_id' in item) which then tells the rest of the branch item is Collection, and then also do we need to type (item: Collection | Track) or can that come from feedItem's type?

Good call, yeah that all makes sense

dylanjeffers · 2022-07-27T18:31:34Z

  static async searchTags({
-    searchText,
-    minTagThreshold,
+    query,


ah looks like it was changed, nice

dylanjeffers · 2022-07-27T18:32:55Z

      return true
    } catch (err) {
-      console.error(err.message)
+      console.log(getErrorMessage(err))


getErrorMessage so clutch

dylanjeffers · 2022-07-27T18:33:48Z

    referrer = null,
    feePayerOverride = null
+  }: {
+    email: string


might be nice to create standalone type for this

I agree but I think I'm gonna leave this for now because the type would have to live all the way at the top of the file outside of the AudiusBackend class. The benefit of having it colocated with the function outweighs the separate type imo here. Can def fix once AudiusBackend is split up and potentially not a class anymore

dylanjeffers · 2022-07-27T18:34:36Z

    feePayerOverride,
    isFinalAttempt
+  }: {
+    challenges: { challenge_id: ChallengeRewardID; specifier: string }[]


and here too potentially

audius-infra · 2022-07-29T16:13:44Z

Preview this change https://demo.audius.co/sk-audius-backend-port

audius-infra · 2022-07-29T16:39:20Z

Preview this change https://demo.audius.co/sk-audius-backend-port

audius-infra · 2022-07-29T17:09:20Z

Preview this change https://demo.audius.co/sk-audius-backend-port

dylanjeffers · 2022-07-29T22:12:03Z

-        .map((track: Track) => track.track_id)
-        .filter(Boolean)
+
+      const tracks = lineupItems.filter(


dylanjeffers · 2022-07-29T22:12:24Z

+    const accountUserId = yield* select(getUserId)
+    const userMetadata = yield* select(getAccountUser)
+    if (!accountUserId || !userMetadata) return
+    yield* put(


[c3682b3] [C-780] Update AudiusBackend to work in native context (#1677) Dylan Jeffers [398093d] [C-781] Add minimum threshold to common password check (#1684) Kyle Shanks [5a66847] Ensure fetch calls are awaited so errors are caught (#1683) Sebastian Klingler [d597054] Make audiusBackend configurable for different environments (#1670) Sebastian Klingler [b5fa3fa] Fix native build with new metro-config dependencies (#1676) Dylan Jeffers [408a425] [C-771] Update native metro-config to enable @audius/sdk (#1671) Dylan Jeffers [afde38e] [PAY-416] Early access mode & feature flag refactor (#1654) Michael Piazza [3b28c7e] Fix typecheck for mobile after AudiusBackend ts migration (#1672) Sebastian Klingler [e5fbbb5] Revert "Revert "Update explore endpoints in libs to use v1 (#1539)" (#1609)" (#1669) Joseph Lee [237784b] Default endpoints to empty array instead of null (#1665) Marcus Pasell [175e5d6] Add ModalContentPages to stems (#1659) Marcus Pasell [fdadaac] fix mobile menu on narrow (#1664) nicoback2 [3e2b499] Convert AudiusBackend to typescript (#1650) Sebastian Klingler

Convert AudiusBackend to typescript

5d4c1ec

pull-request-size Bot added the size/XL label Jul 26, 2022

sliptype added 2 commits July 27, 2022 11:44

Fix type errors

e26371d

Merge branch 'main' into sk-audius-backend-port

3b6f993

Remove any, add comment

03e4454

sliptype requested a review from dylanjeffers July 27, 2022 18:01

sliptype marked this pull request as ready for review July 27, 2022 18:01

dylanjeffers approved these changes Jul 27, 2022

View reviewed changes

sliptype added 2 commits July 29, 2022 10:44

Merge branch 'main' into sk-audius-backend-port

23ebdf6

Fix merge type issues

2b7f57f

Use typed-redux-saga to infer types

7cf4262

pull-request-size Bot added size/XXL and removed size/XL labels Jul 29, 2022

Address pr comments

f44bc93

sliptype requested a review from dylanjeffers July 29, 2022 16:53

Remove unused import

79df3f8

dylanjeffers approved these changes Jul 29, 2022

View reviewed changes

sliptype merged commit 3e2b499 into main Aug 1, 2022

sliptype deleted the sk-audius-backend-port branch August 1, 2022 15:18

Conversation

sliptype commented Jul 26, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Dragons

How Has This Been Tested?

How will this change be monitored?

Feature Flags

Uh oh!

audius-infra commented Jul 26, 2022

Uh oh!

audius-infra commented Jul 27, 2022

Uh oh!

audius-infra commented Jul 27, 2022

Uh oh!

dylanjeffers left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dylanjeffers Jul 27, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dylanjeffers Jul 27, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dylanjeffers Jul 27, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

audius-infra commented Jul 29, 2022

Uh oh!

audius-infra commented Jul 29, 2022

Uh oh!

audius-infra commented Jul 29, 2022

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

sliptype commented Jul 26, 2022 •

edited

Loading

dylanjeffers Jul 27, 2022 •

edited

Loading

dylanjeffers Jul 27, 2022 •

edited

Loading

dylanjeffers Jul 27, 2022 •

edited

Loading