✨ Improvement: safer product setup (ITISFoundation#3395)

Author: pcrespov

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

@@ -1,6 +1,6 @@
 from enum import Enum
 
-from pydantic import PositiveInt, conint, constr
+from pydantic import HttpUrl, PositiveInt, conint, constr
 
 from .basic_regex import UUID_RE, VERSION_RE
 
@@ -26,6 +26,10 @@
 # auto-incremented primary-key IDs
 IdInt = PrimaryKeyInt = PositiveInt
 
+# https e.g. https://techterms.com/definition/https
+class HttpSecureUrl(HttpUrl):
+    allowed_schemes = {"https"}
+
 
 class LogLevel(str, Enum):
     DEBUG = "DEBUG"

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

@@ -9,8 +9,9 @@
     PUBLIC_VARIABLE_NAME_RE,
     TWILIO_ALPHANUMERIC_SENDER_ID_RE,
 )
+from models_library.basic_types import HttpSecureUrl
 from models_library.utils.change_case import snake_to_camel
-from pydantic import BaseModel, Field, HttpUrl, validator
+from pydantic import BaseModel, EmailStr, Field, validator
 from simcore_postgres_database.models.products import jinja2_templates
 
 from .db_base_repository import BaseRepository
@@ -23,6 +24,8 @@
 #
 # MODEL
 #
+
+
 class Product(BaseModel):
     """
     Pydantic model associated to db_models.Products table
@@ -38,21 +41,21 @@ class Product(BaseModel):
     host_regex: Pattern
 
     # EMAILS/PHONE
-    support_email: str
+    support_email: EmailStr
     twilio_messaging_sid: Optional[str] = Field(
         default=None,
         min_length=34,
         max_length=34,
     )
 
     # MANUALS
-    manual_url: HttpUrl
-    manual_extra_url: Optional[HttpUrl] = None
+    manual_url: HttpSecureUrl
+    manual_extra_url: Optional[HttpSecureUrl] = None
 
     # ISSUE TRACKER
-    issues_login_url: Optional[HttpUrl] = None
-    issues_new_url: Optional[HttpUrl] = None
-    feedback_form_url: Optional[HttpUrl] = None
+    issues_login_url: Optional[HttpSecureUrl] = None
+    issues_new_url: Optional[HttpSecureUrl] = None
+    feedback_form_url: Optional[HttpSecureUrl] = None
 
     # TEMPLATES
     registration_email_template: Optional[str] = Field(
@@ -76,6 +79,18 @@ class Config:
                         if c.server_default and isinstance(c.server_default.arg, str)
                     },
                 },
+                # Example of data in the dabase with a url set with blanks
+                {
+                    "name": "tis",
+                    "display_name": "TI PT",
+                    "short_name": "TIPI",
+                    "host_regex": r"(^tis[\.-])|(^ti-solutions\.)|(^ti-plan\.)",
+                    "support_email": "[email protected]",
+                    "manual_url": "https://foo.com",
+                    "issues_login_url": None,
+                    "issues_new_url": "https://foo.com/new",
+                    "feedback_form_url": "",  # <-- blanks
+                },
             ]
         }
 
@@ -88,6 +103,20 @@ def validate_name(cls, v):
             )
         return v
 
+    @validator(
+        "manual_extra_url",
+        "issues_login_url",
+        "issues_new_url",
+        "feedback_form_url",
+        pre=True,
+    )
+    @classmethod
+    def parse_empty_string_url_as_null(cls, v):
+        """Safe measure: database entries are sometimes left blank instead of null"""
+        if isinstance(v, str) and len(v.strip()) == 0:
+            return None
+        return v
+
     @property
     def twilio_alpha_numeric_sender_id(self) -> str:
         return self.short_name or self.display_name.replace(string.punctuation, "")[:11]

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

@@ -54,3 +54,4 @@ async def load_products_on_startup(app: web.Application):
         log.warning("Default front-end app is not in the products table")
 
     app[APP_PRODUCTS_KEY] = app_products
+    log.debug("Product loaded: %s", [p.name for p in app_products.values()])