-
Notifications
You must be signed in to change notification settings - Fork 106
/
tracks.py
441 lines (395 loc) · 15.9 KB
/
tracks.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
from urllib.parse import urljoin
import logging # pylint: disable=C0302
from flask import redirect
from flask_restx import Resource, Namespace, fields, reqparse, inputs
from src.queries.get_tracks import get_tracks
from src.queries.get_track_user_creator_node import get_track_user_creator_node
from src.api.v1.helpers import abort_not_found, decode_with_abort, \
extend_track, make_response, search_parser, extend_user, get_default_max, \
trending_parser, full_trending_parser, success_response, abort_bad_request_param, to_dict, \
format_offset, format_limit, decode_string_id, stem_from_track, \
get_current_user_id
from .models.tracks import track, track_full, stem_full, remixes_response
from src.queries.search_queries import SearchKind, search
from src.queries.get_trending_tracks import get_trending_tracks
from flask.json import dumps
from src.utils.redis_cache import cache, extract_key, use_redis_cache
from flask.globals import request
from src.utils.redis_metrics import record_metrics
from src.api.v1.models.users import user_model_full
from src.queries.get_reposters_for_track import get_reposters_for_track
from src.queries.get_savers_for_track import get_savers_for_track
from src.queries.get_tracks_including_unlisted import get_tracks_including_unlisted
from src.queries.get_stems_of import get_stems_of
from src.queries.get_remixes_of import get_remixes_of
from src.queries.get_remix_track_parents import get_remix_track_parents
logger = logging.getLogger(__name__)
# Models & namespaces
ns = Namespace('tracks', description='Track related operations')
full_ns = Namespace('tracks', description='Full track operations')
track_response = make_response("track_response", ns, fields.Nested(track))
full_track_response = make_response("full_track_response", full_ns, fields.Nested(track_full))
tracks_response = make_response(
"tracks_response", ns, fields.List(fields.Nested(track)))
full_tracks_response = make_response(
"full_tracks_response", full_ns, fields.List(fields.Nested(track_full))
)
# Get single track
def get_single_track(track_id, current_user_id, endpoint_ns):
args = {
"id": [track_id],
"with_users": True,
"filter_deleted": True,
"current_user_id": current_user_id
}
tracks = get_tracks(args)
if not tracks:
abort_not_found(track_id, endpoint_ns)
single_track = extend_track(tracks[0])
return success_response(single_track)
def get_unlisted_track(track_id, url_title, handle, current_user_id, endpoint_ns):
args = {
"identifiers": [{
"handle": handle,
"url_title": url_title,
"id": track_id
}],
"filter_deleted": False,
"with_users": True,
"current_user_id": current_user_id
}
tracks = get_tracks_including_unlisted(args)
if not tracks:
abort_not_found(track_id, endpoint_ns)
single_track = extend_track(tracks[0])
return success_response(single_track)
TRACK_ROUTE = '/<string:track_id>'
@ns.route(TRACK_ROUTE)
class Track(Resource):
@record_metrics
@ns.doc(
id="""Get Track""",
params={'track_id': 'A Track ID'},
responses={
200: 'Success',
400: 'Bad request',
500: 'Server error'
}
)
@ns.marshal_with(track_response)
@cache(ttl_sec=5)
def get(self, track_id):
"""Fetch a track."""
decoded_id = decode_with_abort(track_id, ns)
return get_single_track(decoded_id, None, ns)
full_track_parser = reqparse.RequestParser()
full_track_parser.add_argument('handle')
full_track_parser.add_argument('url_title')
full_track_parser.add_argument('show_unlisted', type=inputs.boolean)
full_track_parser.add_argument('user_id')
@full_ns.route(TRACK_ROUTE)
class FullTrack(Resource):
@record_metrics
@full_ns.marshal_with(full_track_response)
@cache(ttl_sec=5)
def get(self, track_id):
args = full_track_parser.parse_args()
decoded_id = decode_with_abort(track_id, full_ns)
current_user_id = args.get("user_id")
if current_user_id:
current_user_id = decode_string_id(current_user_id)
if args.get("show_unlisted"):
url_title, handle = args.get("url_title"), args.get("handle")
if not (url_title and handle):
full_ns.abort(400, "Unlisted tracks require url_title and handle")
return get_unlisted_track(decoded_id, url_title, handle, current_user_id, full_ns)
return get_single_track(decoded_id, current_user_id, full_ns)
# Stream
def tranform_stream_cache(stream_url):
return redirect(stream_url)
@ns.route("/<string:track_id>/stream")
class TrackStream(Resource):
@record_metrics
@ns.doc(
id="""Stream Track""",
params={'track_id': 'A Track ID'},
responses={
200: 'Success',
216: 'Partial content',
400: 'Bad request',
416: 'Content range invalid',
500: 'Server error'
}
)
@cache(ttl_sec=5, transform=tranform_stream_cache)
def get(self, track_id):
"""
Get the track's streamable mp3 file.
This endpoint accepts the Range header for streaming.
https://developer.mozilla.org/en-US/docs/Web/HTTP/Range_requests
"""
decoded_id = decode_with_abort(track_id, ns)
args = {"track_id": decoded_id}
creator_nodes = get_track_user_creator_node(args)
if creator_nodes is None:
abort_not_found(track_id, ns)
creator_nodes = creator_nodes.split(',')
if not creator_nodes:
abort_not_found(track_id, ns)
primary_node = creator_nodes[0]
stream_url = urljoin(primary_node, 'tracks/stream/{}'.format(track_id))
return stream_url
track_search_result = make_response(
"track_search", ns, fields.List(fields.Nested(track)))
@ns.route("/search")
class TrackSearchResult(Resource):
@record_metrics
@ns.doc(
id="""Search Tracks""",
params={
'query': 'Search Query',
'only_downloadable': 'Return only downloadable tracks'
},
responses={
200: 'Success',
400: 'Bad request',
500: 'Server error'
}
)
@ns.marshal_with(track_search_result)
@ns.expect(search_parser)
@cache(ttl_sec=60)
def get(self):
"""Search for a track."""
args = search_parser.parse_args()
query = args["query"]
if not query:
abort_bad_request_param('query', ns)
search_args = {
"query": query,
"kind": SearchKind.tracks.name,
"is_auto_complete": False,
"current_user_id": None,
"with_users": True,
"limit": 10,
"offset": 0,
"only_downloadable": args["only_downloadable"]
}
response = search(search_args)
tracks = response["tracks"]
tracks = list(map(extend_track, tracks))
return success_response(tracks)
# Trending
#
# There are two trending endpoints - regular and full. Regular
# uses the familiar caching decorator, while full is more interesting.
#
# Full Trending is consumed page by page in the client, but we'd like to avoid caching
# each page seperately (to avoid old pages interleaving with new ones on the client).
# We're further constrained by the need to fetch more than the page size of ~10 in our playcount
# query in order to score + sort the tracks.
#
# We address this by always fetching and scoring `TRENDING_LIMIT` (>> page limit) tracks,
# caching the entire tracks list. This cached value is sliced by limit + offset and returned.
# This cache entry is be keyed by genre + user_id + time_range.
#
# However, this causes an issue where every distinct user_id (every logged in user) will have a cache miss
# on their first call to trending. We deal with this by adding an additional layer of caching inside
# `get_trending_tracks.py`, which caches the scored tracks before they are populated (keyed by genre + time).
# With this second cache, each user_id can reuse on the same cached list of tracks, and then populate them uniquely.
TRENDING_LIMIT = 100
TRENDING_TTL_SEC = 30 * 60
def get_trending(args):
"""Get Trending, shared between full and regular endpoints."""
# construct args
time = args.get("time") if args.get("time") is not None else 'week'
current_user_id = args.get("user_id")
args = {
'time': time,
'genre': args.get("genre", None),
'with_users': True,
'limit': TRENDING_LIMIT,
'offset': 0
}
# decode and add user_id if necessary
if current_user_id:
decoded_id = decode_string_id(current_user_id)
args["current_user_id"] = decoded_id
tracks = get_trending_tracks(args)
return list(map(extend_track, tracks))
@ns.route("/trending")
class Trending(Resource):
@record_metrics
@ns.doc(
id="""Trending Tracks""",
params={
'genre': 'Trending tracks for a specified genre',
'time': 'Trending tracks over a specified time range (week, month, allTime)'
},
responses={
200: 'Success',
400: 'Bad request',
500: 'Server error'
}
)
@ns.marshal_with(tracks_response)
@cache(ttl_sec=TRENDING_TTL_SEC)
def get(self):
"""Gets the top 100 trending (most popular) tracks on Audius"""
args = trending_parser.parse_args()
trending = get_trending(args)
return success_response(trending)
@full_ns.route("/trending")
class FullTrending(Resource):
def get_cache_key(self):
"""Construct a cache key from genre + user + time"""
request_items = to_dict(request.args)
request_items.pop('limit', None)
request_items.pop('offset', None)
key = extract_key(request.path, request_items.items())
return key
@record_metrics
@full_ns.marshal_with(full_tracks_response)
def get(self):
args = full_trending_parser.parse_args()
offset = format_offset(args)
limit = format_limit(args, TRENDING_LIMIT)
key = self.get_cache_key()
# Attempt to use the cached tracks list
full_trending = use_redis_cache(key, TRENDING_TTL_SEC, lambda: get_trending(args))
trending = full_trending[offset: limit + offset]
return success_response(trending)
track_favorites_route_parser = reqparse.RequestParser()
track_favorites_route_parser.add_argument('user_id', required=False)
track_favorites_route_parser.add_argument('limit', required=False, type=int)
track_favorites_route_parser.add_argument('offset', required=False, type=int)
track_favorites_response = make_response("following_response", full_ns, fields.List(fields.Nested(user_model_full)))
@full_ns.route("/<string:track_id>/favorites")
class FullTrackFavorites(Resource):
@full_ns.expect(track_favorites_route_parser)
@full_ns.doc(
id="""Get Users that Favorited a Track""",
params={
'user_id': 'A User ID',
'limit': 'Limit',
'offset': 'Offset'
},
responses={
200: 'Success',
400: 'Bad request',
500: 'Server error'
}
)
@full_ns.marshal_with(track_favorites_response)
@cache(ttl_sec=5)
def get(self, track_id):
args = track_favorites_route_parser.parse_args()
decoded_id = decode_with_abort(track_id, full_ns)
limit = get_default_max(args.get('limit'), 10, 100)
offset = get_default_max(args.get('offset'), 0)
current_user_id = None
if args.get("user_id"):
current_user_id = decode_string_id(args["user_id"])
args = {
'save_track_id': decoded_id,
'current_user_id': current_user_id,
'limit': limit,
'offset': offset
}
users = get_savers_for_track(args)
users = list(map(extend_user, users))
return success_response(users)
track_reposts_route_parser = reqparse.RequestParser()
track_reposts_route_parser.add_argument('user_id', required=False)
track_reposts_route_parser.add_argument('limit', required=False, type=int)
track_reposts_route_parser.add_argument('offset', required=False, type=int)
track_reposts_response = make_response("following_response", full_ns, fields.List(fields.Nested(user_model_full)))
@full_ns.route("/<string:track_id>/reposts")
class FullTrackReposts(Resource):
@full_ns.expect(track_reposts_route_parser)
@full_ns.doc(
id="""Get Users that Reposted a Track""",
params={
'user_id': 'A User ID',
'limit': 'Limit',
'offset': 'Offset'
},
responses={
200: 'Success',
400: 'Bad request',
500: 'Server error'
}
)
@full_ns.marshal_with(track_reposts_response)
@cache(ttl_sec=5)
def get(self, track_id):
args = track_reposts_route_parser.parse_args()
decoded_id = decode_with_abort(track_id, full_ns)
limit = get_default_max(args.get('limit'), 10, 100)
offset = get_default_max(args.get('offset'), 0)
current_user_id = get_current_user_id(args)
args = {
'repost_track_id': decoded_id,
'current_user_id': current_user_id,
'limit': limit,
'offset': offset
}
users = get_reposters_for_track(args)
users = list(map(extend_user, users))
return success_response(users)
track_stems_response = make_response("stems_response", full_ns, fields.List(fields.Nested(stem_full)))
@full_ns.route("/<string:track_id>/stems")
class FullTrackStems(Resource):
@full_ns.marshal_with(track_stems_response)
@cache(ttl_sec=10)
def get(self, track_id):
decoded_id = decode_with_abort(track_id, full_ns)
stems = get_stems_of(decoded_id)
stems = list(map(stem_from_track, stems))
return success_response(stems)
remixes_response = make_response("remixes_response", full_ns, fields.Nested(remixes_response))
remixes_parser = reqparse.RequestParser()
remixes_parser.add_argument('user_id', required=False)
remixes_parser.add_argument('limit', required=False, default=10)
remixes_parser.add_argument('offset', required=False, default=0)
@full_ns.route("/<string:track_id>/remixes")
class FullRemixesRoute(Resource):
@full_ns.marshal_with(remixes_response)
@cache(ttl_sec=10)
def get(self, track_id):
decoded_id = decode_with_abort(track_id, full_ns)
request_args = remixes_parser.parse_args()
current_user_id = get_current_user_id(request_args)
args = {
"with_users": True,
"track_id": decoded_id,
"current_user_id": current_user_id,
"limit": format_limit(request_args),
"offset": format_offset(request_args)
}
response = get_remixes_of(args)
response["tracks"] = list(map(extend_track, response["tracks"]))
return success_response(response)
remixing_response = make_response("remixing_response", full_ns, fields.List(fields.Nested(track_full)))
remixing_parser = reqparse.RequestParser()
remixing_parser.add_argument('user_id', required=False)
remixing_parser.add_argument('limit', required=False, default=10)
remixing_parser.add_argument('offset', required=False, default=0)
@full_ns.route("/<string:track_id>/remixing")
class FullRemixingRoute(Resource):
@full_ns.marshal_with(remixing_response)
@cache(ttl_sec=10)
def get(self, track_id):
decoded_id = decode_with_abort(track_id, full_ns)
request_args = remixes_parser.parse_args()
current_user_id = get_current_user_id(request_args)
args = {
"with_users": True,
"track_id": decoded_id,
"current_user_id": current_user_id,
"limit": format_limit(request_args),
"offset": format_offset(request_args)
}
tracks = get_remix_track_parents(args)
tracks = list(map(extend_track, tracks))
return success_response(tracks)