🐛 Is91/fix alphanumeric sender (⚠️ devops) (ITISFoundation#3323)

Author: pcrespov

packages/settings-library/setup.cfg

@@ -14,5 +14,6 @@ universal = 1
 # Define setup.py command aliases here
 test = pytest
 
-[tool:pytest]
-asyncio_mode = auto
+# NOTE: uncomment when pytest-asyncio is added in requirements
+# [tool:pytest]
+# asyncio_mode = auto

packages/settings-library/src/settings_library/twilio.py

@@ -6,11 +6,33 @@
 """
 
 
-from pydantic import Field
+from pydantic import Field, constr
 
 from .base import BaseCustomSettings
 
+# Based on https://countrycode.org/
+CountryCodeStr = constr(strip_whitespace=True, regex=r"^\d{1,4}")
+
 
 class TwilioSettings(BaseCustomSettings):
     TWILIO_ACCOUNT_SID: str = Field(..., description="Twilio account String Identifier")
     TWILIO_AUTH_TOKEN: str = Field(..., description="API tokens")
+    TWILIO_COUNTRY_CODES_W_ALPHANUMERIC_SID_SUPPORT: list[CountryCodeStr] = Field(
+        [
+            "41",
+        ],
+        description="list of country-codes supporting/registered for alphanumeric sender ID"
+        "See https://support.twilio.com/hc/en-us/articles/223133767-International-support-for-Alphanumeric-Sender-ID",
+    )
+
+    def is_alphanumeric_supported(self, phone_number: str) -> bool:
+        # Some countries do not support alphanumeric serder ID
+        #
+        # SEE https://support.twilio.com/hc/en-us/articles/223181348-Alphanumeric-Sender-ID-for-Twilio-Programmable-SMS
+        phone_number_wo_international_code = (
+            phone_number.strip().removeprefix("00").lstrip("+")
+        )
+        return any(
+            phone_number_wo_international_code.startswith(code)
+            for code in self.TWILIO_COUNTRY_CODES_W_ALPHANUMERIC_SID_SUPPORT
+        )

packages/settings-library/tests/test_twilio.py

@@ -23,7 +23,43 @@ def test_twilio_settings_within_envdevel(
             {
                 "TWILIO_ACCOUNT_SID": "fake-account",
                 "TWILIO_AUTH_TOKEN": "fake-token",
-                "TWILIO_MESSAGING_SID": "x" * 34,
             },
         )
-        TwilioSettings.create_from_envs()
+        settings = TwilioSettings.create_from_envs()
+        print(settings.json(indent=2))
+        assert settings
+
+
+def test_twilio_settings_with_country_codes(
+    mock_env_devel_environment: dict[str, str], monkeypatch: MonkeyPatch
+):
+
+    # defaults
+    with monkeypatch.context() as patch:
+        setenvs_from_dict(
+            patch,
+            {
+                "TWILIO_ACCOUNT_SID": "fake-account",
+                "TWILIO_AUTH_TOKEN": "fake-token",
+            },
+        )
+        settings = TwilioSettings.create_from_envs()
+
+        assert settings.is_alphanumeric_supported("+41 456 789 156")
+        assert not settings.is_alphanumeric_supported(" +1 123456 789 456 ")
+
+    # custom country codes
+    with monkeypatch.context() as patch:
+        setenvs_from_dict(
+            patch,
+            {
+                "TWILIO_ACCOUNT_SID": "fake-account",
+                "TWILIO_AUTH_TOKEN": "fake-token",
+                "TWILIO_COUNTRY_CODES_W_ALPHANUMERIC_SID_SUPPORT": "[1, 34]",
+            },
+        )
+        settings = TwilioSettings.create_from_envs()
+
+        assert not settings.is_alphanumeric_supported("+41 456 789 156")
+        assert settings.is_alphanumeric_supported(" 001 123456 789 456 ")
+        assert settings.is_alphanumeric_supported("+1 123456 789 456 ")

services/web/server/src/simcore_service_webserver/login/_2fa.py

@@ -15,10 +15,10 @@
 from aiohttp import web
 from pydantic import BaseModel, Field
 from servicelib.logging_utils import log_decorator
+from settings_library.twilio import TwilioSettings
 from twilio.rest import Client
 
 from ..redis import get_redis_validation_code_client
-from .settings import TwilioSettings
 
 log = logging.getLogger(__name__)
 
@@ -82,28 +82,32 @@ async def send_sms_code(
     twilio_alpha_numeric_sender: str,
     user_name: str = "user",
 ):
-    def sender():
+    create_kwargs = {
+        "messaging_service_sid": twilio_messaging_sid,
+        "to": phone_number,
+        "body": f"Dear {user_name[:20].capitalize().strip()}, your verification code is {code}",
+    }
+    if twilo_auth.is_alpha_numeric_supported(phone_number):
+        create_kwargs["from_"] = twilio_alpha_numeric_sender
+
+    def _sender():
         log.info(
             "Sending sms code to %s from product %s",
             f"{phone_number=}",
             twilio_alpha_numeric_sender,
         )
+        #
         # SEE https://www.twilio.com/docs/sms/quickstart/python
         #
         client = Client(twilo_auth.TWILIO_ACCOUNT_SID, twilo_auth.TWILIO_AUTH_TOKEN)
-        message = client.messages.create(
-            messaging_service_sid=twilio_messaging_sid,
-            from_=twilio_alpha_numeric_sender,
-            to=phone_number,
-            body=f"Dear {user_name[:20].capitalize().strip()}, your verification code is {code}",
-        )
+        message = client.messages.create(**create_kwargs)
 
         log.debug(
             "Got twilio client %s",
             f"{message=}",
         )
 
-    await asyncio.get_event_loop().run_in_executor(None, sender)
+    await asyncio.get_event_loop().run_in_executor(None, _sender)
 
 
 #