Use per-message profiles for webhooks

Author: tulir

linearbot/api/types.py

@@ -251,12 +251,14 @@ class Reaction(SerializableAttrs, LinearEventData):
 
 class AttachmentSourceType(SerializableEnum):
     API = "api"
+    GITHUB = "github"
 
 
 @dataclass(kw_only=True)
 class AttachmentSource(SerializableAttrs):
     type: AttachmentSourceType
-    image_url: str = field(json="imageUrl")
+    image_url: Optional[str] = field(json="imageUrl", default=None)
+    pull_request_id: Optional[str] = field(json="pullRequestId", default=None)
 
 
 @dataclass(kw_only=True)
@@ -277,6 +279,14 @@ class UpdatedFrom(SerializableAttrs):
     updated_at: LinearDateTime = field(json="updatedAt")
 
 
+@dataclass
+class LinearActor(SerializableAttrs):
+    id: UUID
+    type: str = "user" # or integration
+    email: Optional[str] = None
+    name: Optional[str] = None
+    avatar_url: str = field(json="avatarUrl", default="")
+
 LinearEventContent = Union[Issue, Comment, Reaction, LabelEvent, Attachment]
 type_to_class = {
     LinearEventType.ISSUE: Issue,
@@ -294,7 +304,9 @@ class LinearEvent(SerializableAttrs):
     created_at: LinearDateTime = field(json="createdAt")
     type: LinearEventType
     data: LinearEventContent
+    actor: Optional[LinearActor] = None
     url: Optional[str] = None
+    organization_id: Optional[UUID] = field(json="organizationId", default=None)
 
     @classmethod
     def deserialize(cls, data: JSON) -> 'LinearEvent':

linearbot/avatar_manager.py

@@ -0,0 +1,51 @@
+from typing import TYPE_CHECKING
+import asyncio
+
+from sqlalchemy import MetaData, Table, Column, Text
+from sqlalchemy.engine.base import Engine
+
+from mautrix.types import ContentURI
+
+if TYPE_CHECKING:
+    from .bot import LinearBot
+
+
+class AvatarManager:
+    bot: 'LinearBot'
+    _avatars: dict[str, ContentURI]
+    _table: Table
+    _db: Engine
+    _lock: asyncio.Lock
+
+    def __init__(self, bot: 'LinearBot', metadata: MetaData) -> None:
+        self.bot = bot
+        self._db = bot.database
+        self._table = Table("avatar", metadata,
+                            Column("url", Text, primary_key=True),
+                            Column("mxc", Text, nullable=False))
+        self._lock = asyncio.Lock()
+        self._avatars = {}
+
+    def load_db(self) -> None:
+        self._avatars = {url: ContentURI(mxc)
+                         for url, mxc
+                         in self._db.execute(self._table.select())}
+
+    async def get_mxc(self, url: str) -> ContentURI:
+        try:
+            return self._avatars[url]
+        except KeyError:
+            pass
+        async with self.bot.http.get(url) as resp:
+            resp.raise_for_status()
+            data = await resp.read()
+        async with self._lock:
+            try:
+                return self._avatars[url]
+            except KeyError:
+                pass
+            mxc = await self.bot.client.upload_media(data)
+            self._avatars[url] = mxc
+            with self._db.begin() as conn:
+                conn.execute(self._table.insert().values(url=url, mxc=mxc))
+        return mxc

linearbot/bot.py

@@ -16,6 +16,7 @@
 from .commands import LinearCommands
 from .client_manager import ClientManager
 from .label_manager import LabelManager
+from .avatar_manager import AvatarManager
 from .util.gitlab import GitLabMigrator
 from .util.prefixless_dm import DMCommandHandler
 
@@ -54,6 +55,7 @@ class LinearBot(Plugin):
     linear_webhook: LinearWebhook
     clients: ClientManager
     labels: LabelManager
+    avatars: AvatarManager
     linear_bot: LinearClient
     commands: LinearCommands
     migrator: GitLabMigrator
@@ -67,13 +69,15 @@ async def start(self):
         self.commands = LinearCommands(self)
         self.clients = ClientManager(self, db_metadata)
         self.labels = LabelManager(self, db_metadata)
+        self.avatars = AvatarManager(self, db_metadata)
         self.migrator = GitLabMigrator(self)
         self.prefixless_dm = DMCommandHandler(self.commands)
 
         self.on_external_config_update()
         db_metadata.create_all(self.database)
         self.clients.load_db()
         self.labels.load_db()
+        self.avatars.load_db()
 
         self.register_handler_class(self.linear_webhook)
         self.register_handler_class(self.commands)

linearbot/webhook.py

@@ -96,6 +96,18 @@ def abort() -> None:
             "action": evt.action.value,
             "data": await evt.data.get_meta(client=self.bot.linear_bot),
         }
+        if evt.actor and evt.actor.name:
+            mxc = ""
+            if evt.actor.avatar_url:
+                try:
+                    mxc = await self.bot.avatars.get_mxc(evt.actor.avatar_url)
+                except Exception:
+                    self.log.warning("Failed to get avatar URL", exc_info=True)
+            content["com.beeper.per_message_profile"] = {
+                "id": str(evt.actor.id),
+                "displayname": evt.actor.name,
+                "avatar_url": mxc,
+            }
         content["com.beeper.linkpreviews"] = []
         if evt.url:
             content.external_url = evt.url