✨ Is91/adds short name for Alphanumeric Sender ID (⚠️ devops) (ITISFoundation#3292)

Author: pcrespov

packages/models-library/src/models_library/basic_regex.py

@@ -43,3 +43,11 @@
 # Datcore file ID
 DATCORE_FILE_ID_RE = rf"^N:package:{UUID_RE_BASE}$"
 DATCORE_DATASET_NAME_RE = rf"^N:dataset:{UUID_RE_BASE}$"
+
+
+TWILIO_ALPHANUMERIC_SENDER_ID_RE = r"(?!^\d+$)^[a-zA-Z0-9\s]{2,11}$"
+#   Alphanumeric Sender IDs may be up to 11 characters long.
+#   Accepted characters include both upper- and lower-case Ascii letters,
+#   the digits 0 through 9, and the space character.
+#   They may not be only numerals.
+# SEE # https://www.twilio.com/docs/glossary/what-alphanumeric-sender-id

packages/models-library/tests/test_basic_regex.py

@@ -12,6 +12,7 @@
 from models_library.basic_regex import (
     DATE_RE,
     PUBLIC_VARIABLE_NAME_RE,
+    TWILIO_ALPHANUMERIC_SENDER_ID_RE,
     UUID_RE,
     VERSION_RE,
 )
@@ -148,3 +149,21 @@ def test_variable_names_regex(string_under_test, expected_match):
         assert variable_re.match(string_under_test)
     else:
         assert not variable_re.match(string_under_test)
+
+
+@pytest.mark.parametrize(
+    "sample, expected",
+    [
+        ("0123456789a", VALID),
+        ("A12b4567 9a", VALID),
+        ("01234567890", INVALID),  #  they may NOT be only numerals.
+        ("0123456789a1", INVALID),  # may be up to 11 characters long
+        ("0-23456789a", INVALID),  # '-' is invalid
+    ],
+)
+def test_TWILIO_ALPHANUMERIC_SENDER_ID_RE(sample, expected):
+    #   Alphanumeric Sender IDs may be up to 11 characters long.
+    #   Accepted characters include both upper- and lower-case Ascii letters,
+    #   the digits 0 through 9, and the space character.
+
+    assert_match_and_get_capture(TWILIO_ALPHANUMERIC_SENDER_ID_RE, sample, expected)

packages/postgres-database/src/simcore_postgres_database/migration/versions/9d477e20d06e_adds_short_name_colm_to_products.py

@@ -0,0 +1,30 @@
+"""Adds short_name colm to products
+
+Revision ID: 9d477e20d06e
+Revises: e5f3167d7277
+Create Date: 2022-08-29 17:53:57.958145+00:00
+
+"""
+import sqlalchemy as sa
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision = "9d477e20d06e"
+down_revision = "e5f3167d7277"
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.add_column(
+        "products",
+        sa.Column("short_name", sa.String(), server_default="osparc", nullable=False),
+    )
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_column("products", "short_name")
+    # ### end Alembic commands ###

packages/postgres-database/src/simcore_postgres_database/models/products.py

@@ -27,6 +27,15 @@
         server_default="o²S²PARC",
         doc="Human readable name of the product or display name",
     ),
+    sa.Column(
+        "short_name",
+        sa.String,
+        nullable=False,
+        server_default="osparc",
+        doc="Alphanumeric name up to 11 characters long with characters "
+        "include both upper- and lower-case Ascii letters, the digits 0 through 9, "
+        "and the space character. They may not be only numerals.",
+    ),
     sa.Column(
         "host_regex",
         sa.String,

packages/postgres-database/tests/test_models_products.py

@@ -100,10 +100,12 @@ async def test_jinja2_templates_table(
             {
                 "name": "s4l",
                 "host_regex": r"(^s4l[\.-])|(^sim4life\.)",
+                "short_name": "s4l web",
                 "registration_email_template": registration_email_template,
             },
             {
                 "name": "tis",
+                "short_name": "TIP",
                 "host_regex": r"(^ti.[\.-])|(^ti-solution\.)",
             },
         ]:
@@ -114,13 +116,15 @@ async def test_jinja2_templates_table(
 
         # prints those products having customized templates
         j = products.join(jinja2_templates)
-        stmt = sa.select([products.c.name, jinja2_templates.c.name]).select_from(j)
+        stmt = sa.select(
+            [products.c.name, jinja2_templates.c.name, products.c.short_name]
+        ).select_from(j)
 
         result: ResultProxy = await conn.execute(stmt)
         assert result.rowcount == 2
         assert await result.fetchall() == [
-            ("osparc", "registration_email.jinja2"),
-            ("s4l", "registration_email.jinja2"),
+            ("s4l", "registration_email.jinja2", "s4l web"),
+            ("osparc", "registration_email.jinja2", "osparc"),
         ]
 
         assert (

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

@@ -79,21 +79,21 @@ async def send_sms_code(
     code: str,
     twilo_auth: TwilioSettings,
     twilio_messaging_sid: str,
-    product_display_name: str,
+    twilio_alpha_numeric_sender: str,
     user_name: str = "user",
 ):
     def sender():
         log.info(
             "Sending sms code to %s from product %s",
             f"{phone_number=}",
-            product_display_name,
+            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_=product_display_name,
+            from_=twilio_alpha_numeric_sender,
             to=phone_number,
             body=f"Dear {user_name[:20].capitalize().strip()}, your verification code is {code}",
         )

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

@@ -179,7 +179,7 @@ async def register_phone(request: web.Request):
             code=code,
             twilo_auth=settings.LOGIN_TWILIO,
             twilio_messaging_sid=product.twilio_messaging_sid,
-            product_display_name=product.display_name,
+            twilio_alpha_numeric_sender=product.twilio_alpha_numeric_sender_id,
             user_name=_get_user_name(email),
         )
 
@@ -311,7 +311,7 @@ async def login(request: web.Request):
                 code=code,
                 twilo_auth=settings.LOGIN_TWILIO,
                 twilio_messaging_sid=product.twilio_messaging_sid,
-                product_display_name=product.display_name,
+                twilio_alpha_numeric_sender=product.twilio_alpha_numeric_sender_id,
                 user_name=user["name"],
             )
 

services/web/server/src/simcore_service_webserver/products_db.py

@@ -1,10 +1,14 @@
 import logging
+import string
 from typing import Any, AsyncIterator, Optional, Pattern
 
 import sqlalchemy as sa
 from aiopg.sa.engine import Engine
 from aiopg.sa.result import ResultProxy, RowProxy
-from models_library.basic_regex import PUBLIC_VARIABLE_NAME_RE
+from models_library.basic_regex import (
+    PUBLIC_VARIABLE_NAME_RE,
+    TWILIO_ALPHANUMERIC_SENDER_ID_RE,
+)
 from models_library.utils.change_case import snake_to_camel
 from pydantic import BaseModel, Field, HttpUrl, validator
 from simcore_postgres_database.models.products import jinja2_templates
@@ -15,6 +19,7 @@
 
 log = logging.getLogger(__name__)
 
+
 #
 # MODEL
 #
@@ -27,6 +32,9 @@ class Product(BaseModel):
 
     name: str = Field(regex=PUBLIC_VARIABLE_NAME_RE)
     display_name: str
+    short_name: Optional[str] = Field(
+        None, regex=TWILIO_ALPHANUMERIC_SENDER_ID_RE, min_length=2, max_length=11
+    )
     host_regex: Pattern
 
     # EMAILS/PHONE
@@ -53,6 +61,23 @@ class Product(BaseModel):
 
     class Config:
         orm_mode = True
+        schema_extra = {
+            "examples": [
+                {
+                    # fake mandatory
+                    "name": "osparc",
+                    "host_regex": r"([\.-]{0,1}osparc[\.-])",
+                    "twilio_messaging_sid": "1" * 34,
+                    "registration_email_template": "osparc_registration_email",
+                    # defaults from sqlalchemy table
+                    **{
+                        c.name: c.server_default.arg
+                        for c in products.columns
+                        if c.server_default and isinstance(c.server_default.arg, str)
+                    },
+                },
+            ]
+        }
 
     @validator("name", pre=True, always=True)
     @classmethod
@@ -63,6 +88,10 @@ def validate_name(cls, v):
             )
         return v
 
+    @property
+    def twilio_alpha_numeric_sender_id(self) -> str:
+        return self.short_name or self.display_name.replace(string.punctuation, "")[:11]
+
     def to_statics(self) -> dict[str, Any]:
         """
         Selects **public** fields from product's info
@@ -89,6 +118,7 @@ def to_statics(self) -> dict[str, Any]:
         }
 
     def get_template_name_for(self, filename: str) -> Optional[str]:
+        """Checks for field marked with 'x_template_name' that fits the argument"""
         template_name = filename.removesuffix(".jinja2")
         for field in self.__fields__.values():
             if field.field_info.extra.get("x_template_name") == template_name:
@@ -100,6 +130,7 @@ def get_template_name_for(self, filename: str) -> Optional[str]:
 # REPOSITORY
 #
 
+# NOTE: This also asserts that all model fields are in sync with sqlalchemy columns
 _include_cols = [products.columns[f] for f in Product.__fields__]
 
 

services/web/server/tests/unit/with_dbs/03/test_products_db.py

@@ -0,0 +1,30 @@
+# pylint: disable=redefined-outer-name
+# pylint: disable=unused-argument
+# pylint: disable=unused-variable
+
+
+from typing import Any
+
+import pytest
+from pydantic import BaseModel
+from servicelib.json_serialization import json_dumps
+from simcore_service_webserver.products_db import Product
+
+
+@pytest.mark.parametrize(
+    "model_cls",
+    (Product,),
+)
+def test_product_examples(
+    model_cls: type[BaseModel], model_cls_examples: dict[str, dict[str, Any]]
+):
+    for name, example in model_cls_examples.items():
+        print(name, ":", json_dumps(example, indent=1))
+        model_instance = model_cls(**example)
+        assert model_instance, f"Failed with {name}"
+
+        if isinstance(model_cls, Product):
+            assert model_instance.to_statics()
+
+            if "registration_email_template" in example:
+                assert model_instance.get_template_name_for("registration_email.jinja2")