add preview image on bluesky post, migrate monthly top contributors

Author: amatissart

backend/requirements.txt

@@ -60,4 +60,5 @@ requests==2.32.2
 tweepy==4.14.0
 # dotenv for .env file
 python-dotenv==1.0.0
-
+# AT protocol library for Bluesky
+atproto==0.0.58

backend/twitterbot/admin.py

@@ -37,7 +37,7 @@ def get_twitter_link(obj):
         """Return the URI of the tweet."""
         return format_html(
             '<a href="{}" target="_blank">Link</a>',
-            obj.tweet_url,
+            obj.message_url,
         )
 
     @staticmethod

backend/twitterbot/management/commands/run_twitterbot.py

@@ -52,4 +52,4 @@ def handle(self, *args, **options):
 
             return
 
-        tweet_video_recommendation(bot_name, assumeyes=options["assumeyes"])
+        tweet_video_recommendation(bot_name, assumeyes=options["assumeyes"], dest=["bluesky"])

backend/twitterbot/management/commands/tweet_top_contributors.py

@@ -26,5 +26,8 @@ def add_arguments(self, parser):
         )
 
     def handle(self, *args, **options):
-
-        tweet_top_contributor_graph(options["bot_name"], assumeyes=options["assumeyes"])
+        tweet_top_contributor_graph(
+            options["bot_name"],
+            assumeyes=options["assumeyes"],
+            dest=["bluesky"],
+        )

backend/twitterbot/settings.py

@@ -47,6 +47,17 @@
     ),
 }
 
+top_contrib_tweet_image_alt = {
+    "en": (
+        "A bar plot showing the users who contributed the most comparisons on Tournesol "
+        "in the last month."
+    ),
+    "fr": (
+        "Un graphique en barres représentant les utilisateur·rice·s ayant effecturé le "
+        "plus de comparaisons sur Tournesol durant le mois dernier."
+    ),
+}
+
 # Name of the Discord channel where the twitterbot will post its tweets.
 # An empty value won't trigger any post.
 TWITTERBOT_DISCORD_CHANNEL = "twitter"

backend/twitterbot/tests/test_tournesolbot.py

@@ -16,7 +16,7 @@
     generate_top_contributor_figure,
     get_best_criteria,
     get_video_recommendations,
-    prepare_tweet,
+    prepare_text,
     tweet_top_contributor_graph,
 )
 
@@ -174,7 +174,7 @@ def test_prepare_tweet(self, mock_get_twitter_account_from_video_id):
 
         mock_get_twitter_account_from_video_id.return_value = "@TournesolApp"
 
-        assert prepare_tweet(self.videos[8], dest="twitter") == tweet_text
+        assert prepare_text(self.videos[8], dest="twitter") == tweet_text
 
         # Test automatic shortening of the video title to fit in the tweet
         self.videos[8].metadata[
@@ -190,7 +190,7 @@ def test_prepare_tweet(self, mock_get_twitter_account_from_video_id):
             "\ntournesol.app/entities/yt:AAAAAAAAAAA"
         )
 
-        assert prepare_tweet(self.videos[8], dest="twitter") == tweet_text_too_long
+        assert prepare_text(self.videos[8], dest="twitter") == tweet_text_too_long
 
         # Test replacement of special characters in the video title
         self.videos[8].metadata["name"] = "Tournesol.app is great but mention @twitter are not..."
@@ -204,7 +204,7 @@ def test_prepare_tweet(self, mock_get_twitter_account_from_video_id):
             "\ntournesol.app/entities/yt:AAAAAAAAAAA"
         )
 
-        assert prepare_tweet(self.videos[8], dest="twitter") == tweet_special_characters
+        assert prepare_text(self.videos[8], dest="twitter") == tweet_special_characters
 
     def test_get_video_recommendations(self):
         """
@@ -297,8 +297,8 @@ def test_tweet_top_contributor_graph(self, api_mock, client_mock):
         mocked_api_client = api_mock.return_value
         mocked_v2_client = client_mock.return_value
 
-        tweet_top_contributor_graph("@TournesolBot", assumeyes=True)
-        tweet_top_contributor_graph("@TournesolBotFR", assumeyes=True)
+        tweet_top_contributor_graph("@TournesolBot", assumeyes=True, dest=["twitter"])
+        tweet_top_contributor_graph("@TournesolBotFR", assumeyes=True, dest=["twitter"])
 
         self.assertEqual(
             mocked_api_client.media_upload.call_count, 2, mocked_api_client.media_upload.calls

backend/twitterbot/tournesolbot.py

@@ -44,7 +44,7 @@ def get_best_criteria(video, nb_criteria):
     return [(crit.criteria, crit.score) for crit in criteria_list]
 
 
-def prepare_tweet(video: Entity, dest: Literal["twitter", "bluesky"]):
+def prepare_text(video: Entity, dest: Literal["twitter", "bluesky"]):
     """Create the tweet text from the video."""
 
     uploader = video.metadata["uploader"]
@@ -68,11 +68,12 @@ def prepare_tweet(video: Entity, dest: Literal["twitter", "bluesky"]):
         CriteriaLocale.objects.filter(language=language).values_list("criteria__name", "label")
     )
 
-    # Replace "@" by a smaller "@" to avoid false mentions in the tweet
-    video_title = video.metadata["name"].replace("@", "﹫")
+    if dest == "twitter":
+        # Replace "@" by a smaller "@" to avoid false mentions in the tweet
+        video_title = video.metadata["name"].replace("@", "﹫")
 
-    # Replace "." in between words to avoid in the tweet false detection of links
-    video_title = re.sub(r"\b(?:\.)\b", "․", video_title)
+        # Replace "." in between words to avoid in the tweet false detection of links
+        video_title = re.sub(r"\b(?:\.)\b", "․", video_title)
 
     # Generate the text of the tweet
     poll_rating = video.all_poll_ratings.get(poll__name=DEFAULT_POLL_NAME)
@@ -103,7 +104,8 @@ def prepare_tweet(video: Entity, dest: Literal["twitter", "bluesky"]):
             video_id=video_id,
         )
 
-    if dest == "twitter":
+    if dest != "bluesky":
+        # on Bluesky the URL preview is attached separately as "embed"
         tweet_text += f"\n{get_video_short_url(video)}"
 
     return tweet_text
@@ -194,11 +196,11 @@ def tweet_video_recommendation(bot_name, dest: list[str], assumeyes=False):
     atproto_uri = None
     # Tweet the video
     if "twitter" in dest:
-        tweet_text = prepare_tweet(video, dest="twitter")
+        tweet_text = prepare_text(video, dest="twitter")
         tweet_id = twitterbot.create_tweet(text=tweet_text)
 
     if "bluesky" in dest:
-        text = prepare_tweet(video, dest="bluesky")
+        text = prepare_text(video, dest="bluesky")
         atproto_uri = twitterbot.create_bluesky_post(text=text, embed_video=video)
 
     # Add the video to the TweetInfo table
@@ -268,7 +270,7 @@ def generate_top_contributor_figure(top_contributors_qs, language="en") -> Path:
     return figure_path
 
 
-def tweet_top_contributor_graph(bot_name, assumeyes=False):
+def tweet_top_contributor_graph(bot_name, dest: list[str], assumeyes=False):
     """Tweet the top contibutor graph of last month.
 
     Args:
@@ -297,15 +299,28 @@ def tweet_top_contributor_graph(bot_name, assumeyes=False):
         if confirmation not in ["y", "yes"]:
             return
 
-    tweet_id = twitterbot.create_tweet(
-        text=settings.top_contrib_tweet_text_template[language],
-        media_files=[top_contributor_figure]
-    )
+    message_url = None
+    if "twitter" in dest:
+        tweet_id = twitterbot.create_tweet(
+            text=settings.top_contrib_tweet_text_template[language],
+            media_files=[top_contributor_figure]
+        )
+        message_url = f"https://twitter.com/{bot_name}/status/{tweet_id}"
 
-    # Post the tweet on Discord
-    discord_channel = settings.TWITTERBOT_DISCORD_CHANNEL
-    if discord_channel:
-        write_in_channel(
-            discord_channel,
-            message=f"https://twitter.com/{bot_name}/status/{tweet_id}",
+    if "bluesky" in dest:
+        post_uri = twitterbot.create_bluesky_post(
+            text=settings.top_contrib_tweet_text_template[language],
+            image_files=[top_contributor_figure],
+            image_alts=[settings.top_contrib_tweet_image_alt[language]]
         )
+        post_id = post_uri.rsplit("/", 1)[-1]
+        message_url = f'https://bsky.app/profile/{twitterbot.bluesky_handle}/post/{post_id}'
+
+    if message_url is not None:
+        # Post the tweet on Discord
+        discord_channel = settings.TWITTERBOT_DISCORD_CHANNEL
+        if discord_channel:
+            write_in_channel(
+                discord_channel,
+                message=message_url,
+            )

backend/twitterbot/twitter_api.py

@@ -2,6 +2,7 @@
 from pathlib import Path
 from typing import List, Optional
 
+import requests
 from django.conf import settings
 
 from tournesol.models import Entity
@@ -43,9 +44,13 @@ def tweepy_client(self):
             access_token_secret=self.account_cred["ACCESS_TOKEN_SECRET"],
         )
 
+    @property
+    def bluesky_handle(self):
+        return self.account_cred["ATPROTO_HANDLE"]
+
     @cached_property
     def atproto_client(self):
-        from atproto import Client
+        from atproto import Client  # pylint:disable=import-outside-toplevel
         client = Client()
         client.login(
             self.account_cred["ATPROTO_HANDLE"],
@@ -73,18 +78,23 @@ def create_bluesky_post(
         image_files: Optional[List[Path]] = None,
         image_alts: Optional[List[str]] = None,
     ):
-        from atproto import models
+        from atproto import models  # pylint:disable=import-outside-toplevel
         if image_files is None:
             if embed_video is None:
                 embed = None
             else:
+                preview_response = requests.get(
+                    f"https://api.tournesol.app/preview/entities/{embed_video.uid}"
+                )
+                preview_response.raise_for_status()
+                img_data = preview_response.content
+                thumb_blob = self.atproto_client.upload_blob(img_data).blob
                 embed = models.AppBskyEmbedExternal.Main(
                     external=models.AppBskyEmbedExternal.External(
                         title=embed_video.metadata.get("name", ""),
                         description=embed_video.metadata.get("uploader", ""),
-                        uri=f"https://tournesolapp/entities/yt:{embed_video.video_id}",
-                        # TODO: fetch thumbnail from tournesol.app and upload blob
-                        # thumb=blob
+                        uri=f"https://tournesolapp/entities/{embed_video.uid}",
+                        thumb=thumb_blob,
                     )
                 )
             resp = self.atproto_client.send_post(