soundcloud / soundcloud/api

Performance Report: Significantly slower calls to the user playlists endpoint on v1

Open
#7 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
254
Forks
53
PR merge metrics
No merged PRs in 30d

Description

Performance Report: Significantly slower calls to the user playlists endpoint on v1

Issue found of 27/10/2020

We noticed significantly slower performance when requesting data from the v1 user playlists endpoint vs the v2 implementation.

Although this is one particular example, we wonder if there might be other performance issues.

As we migrate back to the v1 tracks/playlists endpoints we will collect metrics and compare performances in case this information proves useful to SoundCloud.

Endpoint(s):
  • GET https://api-v2.soundcloud.com/users/4269948/playlists
  • GET https://api.soundcloud.com/users/4269948/playlists
Scope(s):
  • None, (this request requires only a client id)
Expected behaviour

Comparible performance

Actual behaviour

v2 endpoint takes ~1s
v1 endpoint takes ~3s

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing and measuring the two listed user playlists endpoints, comparing the v1 response with the v2 response for the provided user and client-id-only scope. Review the collected v1 tracks/playlists metrics if available; done means identifying and addressing the cause of the performance gap, with comparable timings documented.

Written by the indexing model from the issue text.

Assessment

Domain
api, backend-api-design, performance
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.