Fedora Badges Message consumer
==============================
This repo contains the consumer and the command necessary to hook the
badges stack (Tahrir, Tahrir-API, Tahrir-REST) into Fedora Messaging.
It is the process that runs in the background, monitoring activity of Fedora
contributors, and is responsible for awarding badges for activity as it happens.
It is separate from and sometimes confused with the *frontend* of the badges system
called `tahrir <https://github.com/fedora-infra/tahrir>`_.
This project (fedbadges) writes to a database that the web frontend (tahrir) reads
from.
The *actual badge rules* that we act on in Fedora Infrastructure can be
found `here <https://pagure.io/Fedora-Badges>`.
Architecture
------------
fedbadges is a callback class for the Fedora Messaging consumer.
When started, it will load some initial configuration
and a set of ``BadgeRules`` (more on that later) and then sit quietly
listening to the Fedora Messaging bus. Each rule (composed of some metadata,
a ``trigger``, and a set of ``criteria``) is defined on disk as a yaml file.
* When a new message comes along, our callback looks to see if it matches
any of the ``BadgeRules`` it has registered.
* Each BadgeRule must define a ``trigger`` -- a *lightweight* check.
When processing a message, this is the first thing that is checked. It
defines a *pattern* that the message must match. If the message does not
match, then the current BadgeRule is discarded and processing moves to
the next.
A ``trigger`` is typically something like "any bodhi message"
or "messages only from the failure of a koji build". More on their
specification below.
* BadgeRules must also define a set of ``criteria`` -- a more *heavyweight*
check. During the processing of a newly received message, if the
message matches a BadgeRule's ``trigger``, the ``criteria`` is then
considered. This typically involves a more expensive query to the
`datanommer <https://github.com/fedora-infra/datanommer>`_ database.
A BadgeRule ``criteria`` may read something like "$user has
pushed 200 bodhi updates to stable" or "$user chaired an IRC meeting".
**Aside:** Although datanommer is the only currently supported backend, we
can implement other queryable backend in the future as needed like FAS
(to see if the user is in X number of groups) or even off-site services
like libravatar (to award a badge if the user is a user of the AGPL web
service).
* If a badge's ``trigger`` and ``criteria`` both match, then the badge is
awarded. If the BadgeRule doesn't specify, we award the badge to all
usernames returned by the message's ``usernames`` property.
That is usually correct -- but sometimes, a BadgeRule needs to specify
that one particular user (not all related users) should be recipients of
the badge. In this case, the BadgeRule may define a ``recipient``
in dot-notation that instructs the ``Consumer`` how to extract the
recipient's username from the received message.
The badge is awarded to our deserving user via the `tahrir_api
<https://github.com/fedora-infra/tahrir-api>`_. At the end of the day,
this amounts to adding a row in a database table for the `Tahrir
<https://github.com/fedora-infra/tahrir>`_ application.
There are some optimizations in place omitted above for clarity.
For instance, after the trigger has matched we first check if the user
that *would* be awarded the badge already has it. If they do, we stop
processing the badge rule immediately to avoid making an unnecessary
expensive check against the datanommer db.
Configuration - Global
----------------------
fedbadges needs three major pieces of global configuration.
All configuration is loaded in the standard Fedora Messaging way, from
the ``[consumer_config]`` section of the configuration file. See
`fedbadges.toml.example
<https://github.com/fedora-infra/fedbadges/blob/develop/fedbadges.toml.example>`_
in the git repo for an example.
fedbadges also emits its own messages. Please note that the ``topic_prefix`` in
the configuration should at least be ``badges``. In the Fedora Infrastructure,
it will be ``org.fedoraproject.prod.badges``.
Configuration - BadgeRule specification
---------------------------------------
BadgeRules are specified in `YAML <http://www.yaml.org/>`_ on the file system.
Triggers
~~~~~~~~
Every BadgeRule must carry the following minimum set of metadata::
# This is some metadata about the badge
name: Like a Rock
description: You have pushed 500 or more bodhi updates to stable status.
creator: ralph
# This is a link to the discussion about adopting this as a for-real badge.
discussion: http://github.com/fedora-infra/badges/pull/SOME_NUMBER
# A link to the image for the badge
image_url: http://somelink.org/to-an-image.png
Here's a simple example of a ``trigger``::
trigger:
category: bodhi
The above will match any bodhi message on any of the topics that come
from the bodhi update system.
Triggers may employ a little bit of logic to make more complex
filters. The following trigger will match any message that comes from
*either* the bodhi update system or the fedora git package repos::
trigger:
category:
any:
- bodhi
- git
At present triggers may directly compare themselves against only the
`category` or the `topic` of a message. In the future we'd like to add
more comparisons.. in the meantime, here's an example of comparing against
the fully qualified message topic. This will match any message
that is specifically for editing a wiki page::
trigger:
topic: org.fedoraproject.prod.wiki.article.edit
----
There is one additional way you can specify a trigger. If you need more
flexibility than ``topic`` and
``category`` allow, you may specify a custom filter expression with a
``lambda`` filter. For example::
trigger:
lambda: "a string of interest" in json.dumps(msg)
The above trigger will match if the string ``"a string of interest"`` appears
anywhere in the incoming message. fedbadges takes the expression you provide
it and compiles it into a python callable on initialization. Our callable
here serializes the message to a JSON string before doing its comparison.
Powerful!
Criteria
~~~~~~~~
As mentioned above in the architecture section, we currently only support
datanommer as a queryable backend for criteria. We hope to expand that
in the future.
Datanommer criteria are composed of three things:
- A **filter** limits the scope of the query to datanommer.
- An **operation** defines what we want to do with the filtered query.
Currently, we can only *count* the results.
- A **condition** defines how we want to compare the results of the
**operation** to determine if our criteria matches or not.
Here's an example of a simple criteria definition::
criteria:
filter:
topics:
- "%(topic)s"
operation: count
condition:
greater than or equal to: 2
The above criteria will match if there is more than one message in datanommer
with the same topic as the incoming message being handled. Here, ``"%(topic)s"``
is a `template variable`. Template variables will have their values
substituted before the expensive check is made against datanommer.
----
The above example doesn't make much sense -- we'd never use it for a real
badge. The criteria would be true if there were two of *any* message kicked
off by *any* user at any time in the past. Pretty generic.
Here's a more interesting criteria definition::
criteria:
filter:
topics:
- org.fedoraproject.prod.git.receive
usernames:
- "%(msg.commit.username)s"
operation: count
condition:
greater than or equal to: 50
This criteria would match if there existed 50 messages of the topic
``"org.fedoraproject.prod.git.receive"`` that were also kicked off by whatever
user is listed in the ``msg['msg']['commit']['username']`` field of the
message being currently processed. In other words, this criteria would match
if the user has pushed to the fedora git repos 50 or more times.
----
You can do some fancy things with the **condition** of a datanommer
filter. Here's a list of the possible comparisons you can make:
- ``"is greater than or equal to"`` or alternatively
``"greater than or equal to"``
- ``"greater than"``
- ``"is less than or equal to"`` or alternatively
``"less than or equal to"``
- ``"less than"``
- ``"equal to"`` or alternatively ``"is equal to"``
- ``"is not"`` or alternatively ``"is not equal to"``
As you can see, some of them are synonyms for each other.
----
If any of those don't meet your needs, you can specify a custom expression
by using the ``lambda`` condition whereby fedbadges will compile whatever
statement you provide into a callable and use that at runtime. For example::
criteria:
filter:
topics:
- org.fedoraproject.prod.git.receive
usernames:
- "%(msg.commit.username)s"
operation: count
condition:
lambda: value != 0 and ((value & (value - 1)) == 0)
Who knows why you would want to do this, but the above criteria check will
succeed if the number of messages returned from the filtered datanommer query
is exactly a power of 2.
Specifying Recipients
~~~~~~~~~~~~~~~~~~~~~
By default, if the trigger and criteria match, fedbadges will award badges
to all the users returned by the message's ``usernames`` property.
This *usually* corresponds with "what users are responsible" for this message.
That is *usually* what we want to award badges for.
There are some instances for which that is not what we want.
Take the `org.fedoraproject.prod.fas.group.member.sponsor
<https://fedora-messaging.readthedocs.io/en/stable/user-guide/schemas.html#fas>`_
message for example. When user A sponsors user B to a group, both
usernames are returned by the message's ``usernames`` property with no
further distinction as to which was adding and which was added.
Imagine we have a "Group Sponsor" badge that's awarded to group admins who
sponsor users to groups. We don't want to inadvertently award that badge
to the persons who *were sponsored*, only to those who *sponsored them*.
To allow for this scenario, badges may optionally define a ``recipient``
in dotted notation that tells fedbadges where to find the username of the
recipient in the originating message. For instance, the following would
handle the fas case we described above::
trigger:
topic: org.fedoraproject.prod.fas.group.member.sponsor
criteria:
filter:
topics:
- "%(topic)s"
operation: count
condition:
greater than or equal to: 1
recipient: "%(msg.agent_name)s"
Raw data
{
"_id": null,
"home_page": "https://github.com/fedora-infra/fedbadges",
"name": "fedbadges",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": "fedora",
"author": "Fedora Infrastructure",
"author_email": "admin@fedoraproject.org",
"download_url": "https://files.pythonhosted.org/packages/72/58/52a88ebda0c817d9afaad6912642dd200ee47476a0254424c566b0703c18/fedbadges-2.0.0.tar.gz",
"platform": null,
"description": "Fedora Badges Message consumer\n==============================\n\nThis repo contains the consumer and the command necessary to hook the\nbadges stack (Tahrir, Tahrir-API, Tahrir-REST) into Fedora Messaging.\nIt is the process that runs in the background, monitoring activity of Fedora\ncontributors, and is responsible for awarding badges for activity as it happens.\nIt is separate from and sometimes confused with the *frontend* of the badges system\ncalled `tahrir <https://github.com/fedora-infra/tahrir>`_.\nThis project (fedbadges) writes to a database that the web frontend (tahrir) reads\nfrom.\n\nThe *actual badge rules* that we act on in Fedora Infrastructure can be\nfound `here <https://pagure.io/Fedora-Badges>`.\n\nArchitecture\n------------\n\nfedbadges is a callback class for the Fedora Messaging consumer.\nWhen started, it will load some initial configuration\nand a set of ``BadgeRules`` (more on that later) and then sit quietly\nlistening to the Fedora Messaging bus. Each rule (composed of some metadata,\na ``trigger``, and a set of ``criteria``) is defined on disk as a yaml file.\n\n* When a new message comes along, our callback looks to see if it matches\n any of the ``BadgeRules`` it has registered.\n\n* Each BadgeRule must define a ``trigger`` -- a *lightweight* check.\n When processing a message, this is the first thing that is checked. It\n defines a *pattern* that the message must match. If the message does not\n match, then the current BadgeRule is discarded and processing moves to\n the next.\n\n A ``trigger`` is typically something like \"any bodhi message\"\n or \"messages only from the failure of a koji build\". More on their\n specification below.\n\n* BadgeRules must also define a set of ``criteria`` -- a more *heavyweight*\n check. During the processing of a newly received message, if the\n message matches a BadgeRule's ``trigger``, the ``criteria`` is then\n considered. This typically involves a more expensive query to the\n `datanommer <https://github.com/fedora-infra/datanommer>`_ database.\n\n A BadgeRule ``criteria`` may read something like \"$user has\n pushed 200 bodhi updates to stable\" or \"$user chaired an IRC meeting\".\n\n **Aside:** Although datanommer is the only currently supported backend, we\n can implement other queryable backend in the future as needed like FAS\n (to see if the user is in X number of groups) or even off-site services\n like libravatar (to award a badge if the user is a user of the AGPL web\n service).\n\n* If a badge's ``trigger`` and ``criteria`` both match, then the badge is\n awarded. If the BadgeRule doesn't specify, we award the badge to all\n usernames returned by the message's ``usernames`` property.\n\n That is usually correct -- but sometimes, a BadgeRule needs to specify\n that one particular user (not all related users) should be recipients of\n the badge. In this case, the BadgeRule may define a ``recipient``\n in dot-notation that instructs the ``Consumer`` how to extract the\n recipient's username from the received message.\n\n The badge is awarded to our deserving user via the `tahrir_api\n <https://github.com/fedora-infra/tahrir-api>`_. At the end of the day,\n this amounts to adding a row in a database table for the `Tahrir\n <https://github.com/fedora-infra/tahrir>`_ application.\n\nThere are some optimizations in place omitted above for clarity.\nFor instance, after the trigger has matched we first check if the user\nthat *would* be awarded the badge already has it. If they do, we stop\nprocessing the badge rule immediately to avoid making an unnecessary\nexpensive check against the datanommer db.\n\nConfiguration - Global\n----------------------\n\nfedbadges needs three major pieces of global configuration.\nAll configuration is loaded in the standard Fedora Messaging way, from\nthe ``[consumer_config]`` section of the configuration file. See\n`fedbadges.toml.example\n<https://github.com/fedora-infra/fedbadges/blob/develop/fedbadges.toml.example>`_\nin the git repo for an example.\n\nfedbadges also emits its own messages. Please note that the ``topic_prefix`` in\nthe configuration should at least be ``badges``. In the Fedora Infrastructure,\nit will be ``org.fedoraproject.prod.badges``.\n\nConfiguration - BadgeRule specification\n---------------------------------------\n\nBadgeRules are specified in `YAML <http://www.yaml.org/>`_ on the file system.\n\nTriggers\n~~~~~~~~\n\nEvery BadgeRule must carry the following minimum set of metadata::\n\n # This is some metadata about the badge\n name: Like a Rock\n description: You have pushed 500 or more bodhi updates to stable status.\n creator: ralph\n\n # This is a link to the discussion about adopting this as a for-real badge.\n discussion: http://github.com/fedora-infra/badges/pull/SOME_NUMBER\n\n # A link to the image for the badge\n image_url: http://somelink.org/to-an-image.png\n\nHere's a simple example of a ``trigger``::\n\n trigger:\n category: bodhi\n\nThe above will match any bodhi message on any of the topics that come\nfrom the bodhi update system.\n\nTriggers may employ a little bit of logic to make more complex\nfilters. The following trigger will match any message that comes from\n*either* the bodhi update system or the fedora git package repos::\n\n trigger:\n category:\n any:\n - bodhi\n - git\n\nAt present triggers may directly compare themselves against only the\n`category` or the `topic` of a message. In the future we'd like to add\nmore comparisons.. in the meantime, here's an example of comparing against\nthe fully qualified message topic. This will match any message\nthat is specifically for editing a wiki page::\n\n trigger:\n topic: org.fedoraproject.prod.wiki.article.edit\n\n----\n\nThere is one additional way you can specify a trigger. If you need more\nflexibility than ``topic`` and\n``category`` allow, you may specify a custom filter expression with a\n``lambda`` filter. For example::\n\n trigger:\n lambda: \"a string of interest\" in json.dumps(msg)\n\nThe above trigger will match if the string ``\"a string of interest\"`` appears\nanywhere in the incoming message. fedbadges takes the expression you provide\nit and compiles it into a python callable on initialization. Our callable\nhere serializes the message to a JSON string before doing its comparison.\nPowerful!\n\nCriteria\n~~~~~~~~\n\nAs mentioned above in the architecture section, we currently only support\ndatanommer as a queryable backend for criteria. We hope to expand that\nin the future.\n\nDatanommer criteria are composed of three things:\n\n- A **filter** limits the scope of the query to datanommer.\n- An **operation** defines what we want to do with the filtered query.\n Currently, we can only *count* the results.\n- A **condition** defines how we want to compare the results of the\n **operation** to determine if our criteria matches or not.\n\nHere's an example of a simple criteria definition::\n\n criteria:\n filter:\n topics:\n - \"%(topic)s\"\n operation: count\n condition:\n greater than or equal to: 2\n\nThe above criteria will match if there is more than one message in datanommer\nwith the same topic as the incoming message being handled. Here, ``\"%(topic)s\"``\nis a `template variable`. Template variables will have their values\nsubstituted before the expensive check is made against datanommer.\n\n----\n\nThe above example doesn't make much sense -- we'd never use it for a real\nbadge. The criteria would be true if there were two of *any* message kicked\noff by *any* user at any time in the past. Pretty generic.\nHere's a more interesting criteria definition::\n\n criteria:\n filter:\n topics:\n - org.fedoraproject.prod.git.receive\n usernames:\n - \"%(msg.commit.username)s\"\n operation: count\n condition:\n greater than or equal to: 50\n\nThis criteria would match if there existed 50 messages of the topic\n``\"org.fedoraproject.prod.git.receive\"`` that were also kicked off by whatever\nuser is listed in the ``msg['msg']['commit']['username']`` field of the\nmessage being currently processed. In other words, this criteria would match\nif the user has pushed to the fedora git repos 50 or more times.\n\n----\n\nYou can do some fancy things with the **condition** of a datanommer\nfilter. Here's a list of the possible comparisons you can make:\n\n- ``\"is greater than or equal to\"`` or alternatively\n ``\"greater than or equal to\"``\n- ``\"greater than\"``\n- ``\"is less than or equal to\"`` or alternatively\n ``\"less than or equal to\"``\n- ``\"less than\"``\n- ``\"equal to\"`` or alternatively ``\"is equal to\"``\n- ``\"is not\"`` or alternatively ``\"is not equal to\"``\n\nAs you can see, some of them are synonyms for each other.\n\n----\n\nIf any of those don't meet your needs, you can specify a custom expression\nby using the ``lambda`` condition whereby fedbadges will compile whatever\nstatement you provide into a callable and use that at runtime. For example::\n\n\n criteria:\n filter:\n topics:\n - org.fedoraproject.prod.git.receive\n usernames:\n - \"%(msg.commit.username)s\"\n operation: count\n condition:\n lambda: value != 0 and ((value & (value - 1)) == 0)\n\nWho knows why you would want to do this, but the above criteria check will\nsucceed if the number of messages returned from the filtered datanommer query\nis exactly a power of 2.\n\nSpecifying Recipients\n~~~~~~~~~~~~~~~~~~~~~\n\nBy default, if the trigger and criteria match, fedbadges will award badges\nto all the users returned by the message's ``usernames`` property.\nThis *usually* corresponds with \"what users are responsible\" for this message.\nThat is *usually* what we want to award badges for.\n\nThere are some instances for which that is not what we want.\n\nTake the `org.fedoraproject.prod.fas.group.member.sponsor\n<https://fedora-messaging.readthedocs.io/en/stable/user-guide/schemas.html#fas>`_\nmessage for example. When user A sponsors user B to a group, both\nusernames are returned by the message's ``usernames`` property with no\nfurther distinction as to which was adding and which was added.\n\nImagine we have a \"Group Sponsor\" badge that's awarded to group admins who\nsponsor users to groups. We don't want to inadvertently award that badge\nto the persons who *were sponsored*, only to those who *sponsored them*.\n\nTo allow for this scenario, badges may optionally define a ``recipient``\nin dotted notation that tells fedbadges where to find the username of the\nrecipient in the originating message. For instance, the following would\nhandle the fas case we described above::\n\n trigger:\n topic: org.fedoraproject.prod.fas.group.member.sponsor\n criteria:\n filter:\n topics:\n - \"%(topic)s\"\n operation: count\n condition:\n greater than or equal to: 1\n recipient: \"%(msg.agent_name)s\"\n",
"bugtrack_url": null,
"license": "GPL-2.0-or-later",
"summary": "Fedora Messaging consumer for awarding open badges",
"version": "2.0.0",
"project_urls": {
"Homepage": "https://github.com/fedora-infra/fedbadges",
"Repository": "https://github.com/fedora-infra/fedbadges"
},
"split_keywords": [
"fedora"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "75bb69ce877dfe56867d02b598218638dcb37f5547749e6dbe571d3d526a8a50",
"md5": "dfec36bf16b6cef2e58416e3b94d0bd5",
"sha256": "648f0f0fa478560f7db13d25d95d4eefbd308b9d38f19a56ad975ff16d23fb84"
},
"downloads": -1,
"filename": "fedbadges-2.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "dfec36bf16b6cef2e58416e3b94d0bd5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 29840,
"upload_time": "2024-04-16T15:54:24",
"upload_time_iso_8601": "2024-04-16T15:54:24.114117Z",
"url": "https://files.pythonhosted.org/packages/75/bb/69ce877dfe56867d02b598218638dcb37f5547749e6dbe571d3d526a8a50/fedbadges-2.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "725852a88ebda0c817d9afaad6912642dd200ee47476a0254424c566b0703c18",
"md5": "0b782fe5315f72a58862b1b001b6d55c",
"sha256": "6a1a06b7682a7287430ff6a8cf1d042a69ad102c1566e0f383a322ad61c63cd7"
},
"downloads": -1,
"filename": "fedbadges-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "0b782fe5315f72a58862b1b001b6d55c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 48080,
"upload_time": "2024-04-16T15:54:25",
"upload_time_iso_8601": "2024-04-16T15:54:25.921443Z",
"url": "https://files.pythonhosted.org/packages/72/58/52a88ebda0c817d9afaad6912642dd200ee47476a0254424c566b0703c18/fedbadges-2.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-16 15:54:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "fedora-infra",
"github_project": "fedbadges",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "fedbadges"
}
JSON
