Use FASJSON to convert email adresses to FAS usernames

This adds a new dependency on `fasjson_client`. Only users who have set their RHBZ email address in Noggin will be converted.

Fixes: #16
Signed-off-by: Aurélien Bompard <[email protected]>

bugzilla2fedmsg/relay.py

@@ -3,11 +3,12 @@
 
 import pytz
 from bugzilla2fedmsg_schema import MessageV1, MessageV1BZ4
+from fasjson_client import Client as FasjsonClient
 from fedora_messaging.api import publish
 from fedora_messaging.exceptions import ConnectionException, PublishReturned
 from fedora_messaging.message import INFO
 
-from .utils import convert_datetimes
+from .utils import convert_datetimes, email_to_fas
 
 
 LOGGER = logging.getLogger(__name__)
@@ -42,13 +43,49 @@ def _bz4_compat_transform(bug, event, objdict, obj):
         objdict[obj]["author"] = event.get("user", {}).get("login", "")
 
 
+class DropMessage(Exception):
+    def __init__(self, message):
+        self.message = message
+
+    def __str__(self):
+        return self.message
+
+
 class MessageRelay:
     def __init__(self, config):
         self.config = config
         self._allowed_products = self.config.get("bugzilla", {}).get("products", [])
         self._bz4_compat_mode = self.config.get("bugzilla", {}).get("bz4compat", True)
+        self._fasjson = FasjsonClient(self.config["fasjson_url"])
 
     def on_stomp_message(self, body, headers):
+        try:
+            message_body = self._get_message_body(body, headers)
+        except DropMessage as e:
+            LOGGER.debug(f"DROP: {e}")
+            return
+
+        topic = "bug.update"
+        if "bug.create" in headers["destination"]:
+            topic = "bug.new"
+
+        LOGGER.debug("Republishing #%s", message_body["bug"]["id"])
+        messageclass = MessageV1
+        if self._bz4_compat_mode:
+            messageclass = MessageV1BZ4
+        try:
+            message = messageclass(
+                topic=f"bugzilla.{topic}",
+                body=message_body,
+                severity=INFO,
+            )
+            publish(message)
+        except PublishReturned as e:
+            LOGGER.warning(f"Fedora Messaging broker rejected message {message.id}: {e}")
+        except ConnectionException as e:
+            LOGGER.warning(f"Error sending message {message.id}: {e}")
+
+    def _get_message_body(self, body, headers):
         # in BZ 5.0+, public messages include a key for the 'object',
         # whatever the object is. So 'bug.*' messages have a 'bug'
         # dict...but 'comment.*' messages have a 'comment' dict,
@@ -61,8 +98,7 @@ def on_stomp_message(self, body, headers):
         # this splits out the 'bug' part
         obj = headers["destination"].split("bugzilla.")[1].split(".")[0]
         if obj not in body:
-            LOGGER.debug("DROP: message has no object field. Non public.")
-            return
+            raise DropMessage("message has no object field. Non public.")
         objdict = {}
         bug = None
         if obj == "bug":
@@ -78,8 +114,7 @@ def on_stomp_message(self, body, headers):
         # it.
         product_name = bug["product"]["name"]
         if product_name not in self._allowed_products:
-            LOGGER.debug("DROP: %r not in %r", product_name, self._allowed_products)
-            return
+            raise DropMessage(f"{product_name!r} not in {self._allowed_products}")
 
         body["timestamp"] = datetime.datetime.fromtimestamp(
             int(headers["timestamp"]) / 1000.0, pytz.UTC
@@ -90,31 +125,63 @@ def on_stomp_message(self, body, headers):
         if self._bz4_compat_mode:
             _bz4_compat_transform(bug, event, objdict, obj)
 
-        topic = "bug.update"
-        if "bug.create" in headers["destination"]:
-            topic = "bug.new"
-
         # construct message dict, add the object dict we got earlier
         # (for non-'bug' object messages)
-        body = dict(
-            bug=bug,
-            event=event,
-            headers=headers,
-        )
+        body = dict(bug=bug, event=event, headers=headers)
         body.update(objdict)
 
-        LOGGER.debug("Republishing #%s", bug["id"])
-        messageclass = MessageV1
+        # user from the event dict: person who triggered the event
+        agent_name = email_to_fas(event["user"]["login"], self._fasjson)
+        body["agent_name"] = agent_name
+
+        # usernames: all FAS usernames affected by the action
+        all_emails = self._get_all_emails(body)
+        usernames = set()
+        for email in all_emails:
+            username = email_to_fas(email, self._fasjson)
+            if username is None:
+                continue
+            usernames.add(username)
+        if agent_name is not None:
+            usernames.add(agent_name)
+        usernames = list(usernames)
+        usernames.sort()
+        body["usernames"] = usernames
+
+        return body
+
+    def _get_all_emails(self, body):
+        """List of email addresses of all users relevant to the action
+        that generated this message.
+        """
+        emails = set()
+
+        # bug reporter and assignee
+        emails.add(body["bug"]["reporter"]["login"])
         if self._bz4_compat_mode:
-            messageclass = MessageV1BZ4
-        try:
-            message = messageclass(
-                topic=f"bugzilla.{topic}",
-                body=body,
-                severity=INFO,
-            )
-            publish(message)
-        except PublishReturned as e:
-            LOGGER.warning(f"Fedora Messaging broker rejected message {message.id}: {e}")
-        except ConnectionException as e:
-            LOGGER.warning(f"Error sending message {message.id}: {e}")
+            emails.add(body["bug"]["assigned_to"])
+        else:
+            emails.add(body["bug"]["assigned_to"]["login"])
+
+        for change in body["event"].get("changes", []):
+            if change["field"] == "cc":
+                # anyone added to CC list
+                for email in change["added"].split(","):
+                    email.strip()
+                    if email:
+                        emails.add(email)
+            elif change["field"] == "flag.needinfo":
+                # anyone for whom a 'needinfo' flag is set
+                # this is extracting the email from a value like:
+                # "? ([email protected])"
+                email = change["added"].split("(", 1)[1].rsplit(")", 1)[0]
+                if email:
+                    emails.add(email)
+
+        # Strip anything that made it in erroneously
+        for email in list(emails):
+            if email.endswith("lists.fedoraproject.org"):
+                emails.remove(email)
+
+        emails = list(emails)
+        return emails

bugzilla2fedmsg/utils.py

@@ -35,3 +35,13 @@ def convert_datetimes(obj):
             return ourdate.timestamp()
         except (ValueError, TypeError):
             return obj
+
+
+def email_to_fas(email, fasjson):
+    """Try to get a FAS username from an email address, return None if no FAS username is found"""
+    if email.endswith("@fedoraproject.org"):
+        return email.rsplit("@", 1)[0]
+    results = fasjson.search(rhbzemail=email).result
+    if len(results) == 1:
+        return results[0]["username"]
+    return None

devel/ansible/roles/dev/files/config.toml

@@ -10,6 +10,8 @@ amqp_url = "amqp://"
 # certfile = "/my/client/cert.pem"
 
 [consumer_config]
+    fasjson_url = "https://fasjson.tinystage.test"
+
     [consumer_config.stomp]
     # Broker URI
     # http://nikipore.github.io/stompest/protocol.html#stompest.protocol.failover.StompFailoverUri

fedora-messaging.toml.example

@@ -10,6 +10,7 @@ keyfile = "/my/client/key.pem"
 certfile = "/my/client/cert.pem"
 
 [consumer_config]
+    fasjson_url = "https://fasjson.fedoraproject.org"
     [consumer_config.stomp]
     # Broker URI
     # http://nikipore.github.io/stompest/protocol.html#stompest.protocol.failover.StompFailoverUri