adding unidecoder middleware and its tests

Author: Matthew Weppennaar

.DS_Store

@@ -25,6 +25,7 @@ quart-trio = "^0.11.1"
 hypercorn = "^0.16.0"
 "smpp.pdu3" = "^0.6"
 httpx = "^0.26.0"
+unidecode = "^1.3.8"
 
 [tool.poetry.group.dev.dependencies]
 mypy = "^1.8.0"

poetry.lock

@@ -0,0 +1,16 @@
+from unidecode import unidecode
+
+from vumi2.middlewares.base import BaseMiddleware, BaseMiddlewareConfig
+
+
+class Unidecoder(BaseMiddleware):
+    config: BaseMiddlewareConfig
+
+    async def setup(self):
+        pass
+
+    async def handle_outbound(self, message, connection):
+        if message.content:
+            message.content = unidecode(message.content)
+            print(f"unidecoded message {message.content}")
+        return message

pyproject.toml

@@ -0,0 +1,47 @@
+from vumi2.messages import Event, EventType, Message, TransportType
+from vumi2.middlewares.base import BaseMiddlewareConfig
+from vumi2.middlewares.unidecoder import Unidecoder
+
+
+def mkmsg(content: str) -> Message:
+    return Message(
+        to_addr="12345",
+        from_addr="54321",
+        transport_name="test",
+        transport_type=TransportType.SMS,
+        content=content,
+    )
+
+
+def mkev(msg_id: str) -> Event:
+    return Event(
+        user_message_id=msg_id,
+        event_type=EventType.ACK,
+        sent_message_id=msg_id,
+    )
+
+
+async def test_unicode_handle_outbound_with_latin_characters():
+    config = BaseMiddlewareConfig(
+        "vumi2.middlewares.unidecoder.Unidecoder",
+        enable_for_connectors=["connection1", "connection2"],
+        outbound_enabled=True,
+    )
+    middleware = Unidecoder(config)
+    await middleware.setup()
+    message = mkmsg("Goodbye")
+    sent_message = await middleware.handle_outbound(message, "connection1")
+    assert sent_message.content == "Goodbye"
+
+
+async def test_unicode_handle_outbound_with_non_latin_characters():
+    config = BaseMiddlewareConfig(
+        "vumi2.middlewares.unidecoder.Unidecoder",
+        enable_for_connectors=["connection1", "connection2"],
+        outbound_enabled=True,
+    )
+    middleware = Unidecoder(config)
+    await middleware.setup()
+    message = mkmsg("до свидания")
+    sent_message = await middleware.handle_outbound(message, "connection1")
+    assert sent_message.content == "do svidaniia"

src/vumi2/middlewares/unidecoder.py

@@ -716,3 +716,31 @@ async def test_middleware_setup_called(worker_factory, connector_factory):
     middleware = worker.middlewares
     assert isinstance(middleware[0], ToyMiddleware)
     assert middleware[0].config.test == "test10"
+
+
+async def test_unicoder(worker_factory, connector_factory):
+    middleware_config = {
+        "class_path": "vumi2.middlewares.unidecoder.Unidecoder",
+        "enable_for_connectors": ["test", "app"],
+        "inbound_enabled": False,
+        "outbound_enabled": True,
+        "event_enabled": False,
+    }
+    async with worker_factory.with_cleanup(
+        MiddlewareWorker, middleware_config
+    ) as worker:
+        await worker.setup()
+        ri_app = await connector_factory.setup_ri("app")
+        ro_test = await connector_factory.setup_ro("test")
+        message_hello = mkmsg("Hello")
+        message_goodbye = mkmsg("до свидания")
+        message_id = message_goodbye.message_id
+        await ro_test.publish_inbound(message_hello)
+        message_hello_test = await ri_app.consume_inbound()
+        await ri_app.publish_outbound(message_goodbye)
+        message_goodbye_test = await ro_test.consume_outbound()
+        await ro_test.publish_event(mkev(message_id))
+        event = await ri_app.consume_event()
+    assert message_hello_test.content == "Hello"
+    assert message_goodbye_test.content == "Goodbye"
+    assert event.helper_metadata == {}