add basic support for django_tasks

Author: artcz

Makefile

@@ -44,6 +44,9 @@ manage:
 bot:
 	$(DEV_CMD) run_bot
 
+worker:
+	$(DEV_CMD) db_worker -v 2
+
 
 # Test, lint, etc
 # ================

intbot/.env.example

@@ -1 +1,3 @@
 DISCORD_BOT_TOKEN='asdf'
+DISCORD_TEST_CHANNEL_ID="123123123123123123123123"
+DISCORD_TEST_CHANNEL_NAME="#test-channel"

intbot/core/tasks.py

@@ -0,0 +1,31 @@
+from django.conf import settings
+
+from core.models import DiscordMessage, Webhook
+from django.utils import timezone
+from django_tasks import task
+
+
+@task
+def process_webhook(wh_uuid: str):
+    wh = Webhook.objects.get(uuid=wh_uuid)
+
+    if wh.source == "internal":
+        process_internal_webhook(wh)
+
+    else:
+        raise ValueError(f"Unsupported source {wh.source}")
+
+
+def process_internal_webhook(wh: Webhook):
+    if wh.source != "internal":
+        raise ValueError("Incorrect wh.source = {wh.source}")
+
+    DiscordMessage.objects.create(
+        channel_id=settings.DISCORD_TEST_CHANNEL_ID,
+        channel_name=settings.DISCORD_TEST_CHANNEL_NAME,
+        content=f"Webhook content: {wh.content}",
+        # Mark as unsend - to be sent with the next batch
+        sent_at=None,
+    )
+    wh.processed_at = timezone.now()
+    wh.save()

intbot/intbot/settings.py

@@ -28,6 +28,8 @@
     "django.contrib.staticfiles",
     # Third party apps
     "django_extensions",
+    "django_tasks",
+    "django_tasks.backends.database",
     # Project apps
     "core",
 ]
@@ -127,6 +129,12 @@
         }
     }
 
+    TASKS = {
+        "default": {
+            "BACKEND": "django_tasks.backends.database.DatabaseBackend",
+        }
+    }
+
     WEBHOOK_INTERNAL_TOKEN = "dev-token"
 
     # This is only needed if you end up running the bot locally, hence it
@@ -135,9 +143,16 @@
     # one from the developer portal.
     # If you run it locally, you probably want to run it against your own test
     # bot and a test server.
-    DISCORD_BOT_TOKEN = os.environ.get("DISCORD_BOT_TOKEN", "")
-    if not DISCORD_BOT_TOKEN:
-        warnings.warn("DISCORD_BOT_TOKEN not set")
+
+    def warn_if_missing(name, default=""):
+        value = os.environ.get(name, default)
+        if not value:
+            warnings.warn(f"{name} not set")
+
+    DISCORD_TEST_CHANNEL_ID = warn_if_missing("DISCORD_TEST_CHANNEL_ID", "")
+    DISCORD_TEST_CHANNEL_NAME = warn_if_missing("DISCORD_TEST_CHANNEL_NAME", "")
+    DISCORD_BOT_TOKEN = warn_if_missing("DISCORD_BOT_TOKEN", "")
+
 
 elif DJANGO_ENV == "test":
     DEBUG = True
@@ -158,6 +173,22 @@
 
     WEBHOOK_INTERNAL_TOKEN = "test-random-token"
 
+    TASKS = {
+        "default": {
+            "BACKEND": "django_tasks.backends.immediate.ImmediateBackend",
+            # This setting doesn't really make sense in this context, but it
+            # makes it work in the test environment...
+            # TODO(artcz): Let's figure out later why.
+            # NOTE: in django-tasks tests the test harness seem to be quite
+            # different so maybe there's also something we can check in the
+            # library itself.
+            "ENQUEUE_ON_COMMIT": False,
+        }
+    }
+
+    DISCORD_TEST_CHANNEL_ID = "12345"
+    DISCORD_TEST_CHANNEL_NAME = "#test-channel"
+
 
 elif DJANGO_ENV == "local_container":
     DEBUG = False
@@ -179,6 +210,12 @@
         }
     }
 
+    TASKS = {
+        "default": {
+            "BACKEND": "django_tasks.backends.database.DatabaseBackend",
+        }
+    }
+
     # For 500 errors to appear on stderr
     LOGGING = {
         "version": 1,
@@ -220,6 +257,12 @@
         }
     }
 
+    TASKS = {
+        "default": {
+            "BACKEND": "django_tasks.backends.database.DatabaseBackend",
+        }
+    }
+
     # For 500 errors to appear on stderr
     # For now it's good for docker, in the future sentry/or rollabar should be
     # here
@@ -242,6 +285,8 @@
     }
 
     DISCORD_BOT_TOKEN = os.environ["DISCORD_BOT_TOKEN"]
+    DISCORD_TEST_CHANNEL_ID = os.environ["DISCORD_TEST_CHANNEL_ID"]
+    DISCORD_TEST_CHANNEL_NAME = os.environ["DISCORD_TEST_CHANNEL_NAME"]
 
     CSRF_TRUSTED_ORIGINS = [
         "https://internal.europython.eu",

intbot/tests/test_tasks.py

@@ -0,0 +1,43 @@
+import pytest
+from core.models import DiscordMessage, Webhook
+from core.tasks import process_internal_webhook, process_webhook
+from django_tasks.task import ResultStatus
+
+
+@pytest.mark.django_db
+def test_process_internal_webhook_handles_internal_webhook_correctly():
+    wh = Webhook.objects.create(
+        source="internal",
+        event="test1",
+        content={
+            "random": "content",
+        },
+    )
+
+    process_internal_webhook(wh)
+
+    dm = DiscordMessage.objects.get()
+    assert dm.content == "Webhook content: {'random': 'content'}"
+    assert dm.channel_id == "12345"
+    assert dm.channel_name == "#test-channel"
+
+
+@pytest.mark.django_db
+def test_process_internal_webhook_fails_if_incorrect_source():
+    wh = Webhook(source="asdf")
+
+    with pytest.raises(ValueError):
+        process_internal_webhook(wh)
+
+
+@pytest.mark.django_db
+def test_process_webhook_fails_if_unsupported_source(caplog):
+    wh = Webhook.objects.create(source="asdf", event="test1", content={})
+
+    # If the task is enqueued the errors are not emited.
+    # Instead we have to check the result
+    result = process_webhook.enqueue(str(wh.uuid))
+
+    assert result.status == ResultStatus.FAILED
+    assert result._exception_class  == ValueError
+    assert result.traceback.endswith("ValueError: Unsupported source asdf\n")