Merge pull request #166 from metabrainz/LB-1731

LB-1731: Create daily jams for users who don't have enough listens

Author: mayhem

tests/test_filters.py

@@ -2,12 +2,22 @@
 
 import requests_mock
 
+from troi.patch import Patch
 from troi import Artist, ArtistCredit, Recording, Playlist
 import troi.filters
 from troi.musicbrainz.recording import RecordingListElement
 from troi.listenbrainz.feedback import ListensFeedbackLookup
 
 
+class DummyPatch:
+
+    def __init__(self):
+        self.local_storage = {}
+
+    def set_patch_object(self, obj):
+        pass
+
+
 class TestArtistCreditFilterElement(unittest.TestCase):
 
     def test_artist_credit_filter_include(self):
@@ -56,6 +66,7 @@ def test_artist_credit_limiter_higher_ranked(self):
             Recording(mbid='73a9d0db-0ec7-490e-9a85-0525a5ccef8e', artist_credit=ArtistCredit(artist_credit_id=197), ranking=.1)
         ]
 
+
         e = troi.filters.ArtistCreditLimiterElement(1)
         flist = e.read([rlist])
         assert len(flist) == 2
@@ -235,14 +246,17 @@ def test_never_listened_element(self):
             Recording(mbid='c88b3490-35a0-460d-b3bc-bc50c8855d00'),
             Recording(mbid='139654ae-2c02-4e0f-aee0-c47da6e59ff1', listenbrainz={"latest_listened_at": 345345345})
         ]
+        p = DummyPatch()
         e = troi.filters.NeverListenedFilterElement()
+        e.set_patch_object(p)
         flist = e.read([rlist])
         assert len(flist) == 2
 
         assert flist[0].mbid == '8756f690-18ca-488d-a456-680fdaf234bd'
         assert flist[1].mbid == '139654ae-2c02-4e0f-aee0-c47da6e59ff1'
 
         e = troi.filters.NeverListenedFilterElement(remove_unlistened=False)
+        e.set_patch_object(p)
         flist = e.read([rlist])
         assert len(flist) == 2
 

troi/filters.py

@@ -343,9 +343,12 @@ class LatestListenedAtFilterElement(troi.Element):
         :param min_number_of_days: The number of tracks that must have passed for a track to be kept.
     '''
 
-    def __init__(self, min_number_of_days=14):
+    MIN_ITEMS_REQUIRED = 5
+
+    def __init__(self, min_number_of_days=14, keep_unlistened_if_empty=False):
         troi.Element.__init__(self)
         self.min_number_of_days = min_number_of_days
+        self.keep_unlistened_if_empty = keep_unlistened_if_empty
 
     @staticmethod
     def inputs():
@@ -369,6 +372,12 @@ def read(self, inputs):
             else:
                 results.append(r)
 
+        if len(results) < self.MIN_ITEMS_REQUIRED and self.keep_unlistened_if_empty:
+            self.local_storage["latest_listened_was_empty"] = True
+            return recordings
+
+        self.local_storage["latest_listened_was_empty"] = False
+
         return results
 
 
@@ -377,14 +386,17 @@ class NeverListenedFilterElement(troi.Element):
         Remove/keep only recordings if they have not/been listened to.
     '''
 
-    def __init__(self, remove_unlistened=True):
+    MIN_ITEMS_REQUIRED = 5
+
+    def __init__(self, remove_unlistened=True, keep_unlistened_if_empty=False):
         '''
             Filter the recordings according to latest_listened_at field in the lb metadata. 
             If that field is None, treat it as if the user hasn't listened to this track
             and remove it, or keep it, based on the remove_unlistened parameter.
         '''
         troi.Element.__init__(self)
         self.remove_unlistened = remove_unlistened
+        self.keep_unlistened_if_empty = keep_unlistened_if_empty
 
     @staticmethod
     def inputs():
@@ -411,8 +423,12 @@ def read(self, inputs):
                     continue
                 else:
                     results.append(r)
-            
 
+        if len(results) < self.MIN_ITEMS_REQUIRED and self.keep_unlistened_if_empty:
+            self.local_storage["never_listened_was_empty"] = True
+            return recordings
+
+        self.local_storage["never_listened_was_empty"] = False
         return results
 
 

troi/patches/periodic_jams.py

@@ -108,25 +108,32 @@ def create(self, inputs):
 
         if jam_type in ("daily-jams", "weekly-jams"):
             # Remove tracks that have not been listened to before.
-            never_listened = troi.filters.NeverListenedFilterElement()
+            never_listened = troi.filters.NeverListenedFilterElement(keep_unlistened_if_empty=True)
             never_listened.set_sources(recent_listens_lookup)
             if jam_type == "daily-jams":
                 jam_name = "Daily Jams"
             else:
                 jam_name = "Weekly Jams"
                 jam_date = "week of " + jam_date
+            self.local_storage["jam_name"] = jam_name
+
+            latest_filter = troi.filters.LatestListenedAtFilterElement(DAYS_OF_RECENT_LISTENS_TO_EXCLUDE,
+                                                                       keep_unlistened_if_empty=True)
+            latest_filter.set_sources(never_listened)
         elif jam_type == "weekly-exploration":
             # Remove tracks that have been listened to before.
             never_listened = troi.filters.NeverListenedFilterElement(remove_unlistened=False)
             never_listened.set_sources(recent_listens_lookup)
             jam_name = "Weekly Exploration"
             jam_date = "week of " + jam_date
+            self.local_storage["jam_name"] = jam_name
+
+            latest_filter = troi.filters.LatestListenedAtFilterElement(DAYS_OF_RECENT_LISTENS_TO_EXCLUDE)
+            latest_filter.set_sources(never_listened)
+
         else:
             raise RuntimeError("someone goofed up!")
 
-        latest_filter = troi.filters.LatestListenedAtFilterElement(DAYS_OF_RECENT_LISTENS_TO_EXCLUDE)
-        latest_filter.set_sources(never_listened)
-
         feedback_lookup = troi.listenbrainz.feedback.ListensFeedbackLookup(user_name, auth_token=inputs.get("token"))
         feedback_lookup.set_sources(latest_filter)
 
@@ -137,7 +144,7 @@ def create(self, inputs):
         hate_filter.set_sources(recs_lookup)
 
         pl_maker = PlaylistMakerElement(name="%s for %s, %s" % (jam_name, user_name, jam_date),
-                                        desc="%s playlist!" % jam_name,
+                                        desc=None,
                                         patch_slug=jam_type,
                                         max_num_recordings=50,
                                         max_artist_occurrence=2,
@@ -147,3 +154,16 @@ def create(self, inputs):
         pl_maker.set_sources(hate_filter)
 
         return pl_maker
+
+    def post_process(self):
+        """ 
+            Take the information saved in local_storage and create proper playlist names and descriptions.
+        """
+
+        jam_name = self.local_storage["jam_name"]
+        if self.local_storage["latest_listened_was_empty"]:
+            desc = f"This {jam_name} playlist includes tracks you've recently heard, as we don't have enough listens to create a better playlist."
+        else:
+            desc = f"We made this {jam_name} playlist from your recommended tracks to create a comfortable playlist of music you've not listened to recently."
+            
+        self.local_storage["_playlist_desc"] = desc

troi/playlist.py

@@ -228,6 +228,9 @@ def print(self):
                     continue
                 self.print_recording.print(recording)
 
+            if playlist.description:
+                logger.info("description: '%s'" % playlist.description)
+
     def save(self, track_count=None, file_obj=None):
         """Save each playlist to disk, giving each playlist a unique name if none was provided.