settings

Author: pcrespov

.env-devel

@@ -133,7 +133,8 @@ DYNAMIC_SCHEDULER_UI_STORAGE_SECRET=adminadmin
 
 FUNCTION_SERVICES_AUTHORS='{"UN": {"name": "Unknown", "email": "[email protected]", "affiliation": "unknown"}}'
 
-
+WEBSERVER_LICENSES={}
+LICENSES_ITIS_VIP_SYNCER_ENABLED=false
 ITIS_VIP_API_URL=https://itis.swiss/PD_DirectDownload/getDownloadableItems/{category}
 ITIS_VIP_CATEGORIES='{"HumanWholeBody": "Humans", "HumanBodyRegion": "Humans (Region)", "AnimalWholeBody": "Animal"}'
 
@@ -375,7 +376,6 @@ WEBSERVER_GARBAGE_COLLECTOR=null
 WEBSERVER_GROUPS=1
 WEBSERVER_GUNICORN_CMD_ARGS=--timeout=180
 WEBSERVER_HOST=webserver
-WEBSERVER_LICENSES=true
 WEBSERVER_LOGIN={}
 WEBSERVER_LOGLEVEL=INFO
 WEBSERVER_META_MODELING=1

services/docker-compose.yml

@@ -705,6 +705,7 @@ services:
       INVITATIONS_USERNAME: ${INVITATIONS_USERNAME}
 
       WEBSERVER_LICENSES: ${WEBSERVER_LICENSES}
+      LICENSES_ITIS_VIP_SYNCER_ENABLED : ${LICENSES_ITIS_VIP_SYNCER_ENABLED}
       ITIS_VIP_API_URL: ${ITIS_VIP_API_URL}
       ITIS_VIP_CATEGORIES: ${ITIS_VIP_CATEGORIES}
 
@@ -901,7 +902,7 @@ services:
       WEBSERVER_GARBAGE_COLLECTOR: ${WB_DB_EL_GARBAGE_COLLECTOR}
       WEBSERVER_GROUPS: ${WB_DB_EL_GROUPS}
       WEBSERVER_INVITATIONS: ${WB_DB_EL_INVITATIONS}
-      WEBSERVER_LICENSES: 0
+      WEBSERVER_LICENSES: null
       WEBSERVER_LOGIN: ${WB_DB_EL_LOGIN}
       WEBSERVER_PAYMENTS: ${WB_DB_EL_PAYMENTS}
       WEBSERVER_META_MODELING: ${WB_DB_EL_META_MODELING}
@@ -1005,7 +1006,7 @@ services:
       WEBSERVER_FRONTEND: ${WB_GC_FRONTEND}
       WEBSERVER_GROUPS: ${WB_GC_GROUPS}
       WEBSERVER_INVITATIONS: ${WB_GC_INVITATIONS}
-      WEBSERVER_LICENSES: 0
+      WEBSERVER_LICENSES: null
       WEBSERVER_LOGIN: ${WB_GC_LOGIN}
       WEBSERVER_META_MODELING: ${WB_GC_META_MODELING}
       WEBSERVER_NOTIFICATIONS: ${WB_GC_NOTIFICATIONS}

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

@@ -26,6 +26,7 @@
 from settings_library.tracing import TracingSettings
 from settings_library.utils_logging import MixinLoggingSettings
 from settings_library.utils_service import DEFAULT_AIOHTTP_PORT
+from simcore_service_webserver.licenses.settings import LicensesSettings
 
 from ._constants import APP_SETTINGS_KEY
 from ._meta import API_VERSION, API_VTAG, APP_NAME
@@ -231,6 +232,13 @@ class ApplicationSettings(BaseApplicationSettings, MixinLoggingSettings):
         ),
     ]
 
+    WEBSERVER_LICENSES: Annotated[
+        LicensesSettings | None,
+        Field(
+            json_schema_extra={"auto_default_from_env": True},
+        ),
+    ]
+
     WEBSERVER_LOGIN: Annotated[
         LoginSettings | None,
         Field(
@@ -349,7 +357,6 @@ class ApplicationSettings(BaseApplicationSettings, MixinLoggingSettings):
     WEBSERVER_DB_LISTENER: bool = True
     WEBSERVER_FOLDERS: bool = True
     WEBSERVER_GROUPS: bool = True
-    WEBSERVER_LICENSES: bool = False
     WEBSERVER_META_MODELING: bool = True
     WEBSERVER_NOTIFICATIONS: bool = True
     WEBSERVER_PRODUCTS: bool = True
@@ -520,7 +527,6 @@ def to_client_statics(self) -> dict[str, Any]:
                 "SIMCORE_VCS_RELEASE_TAG": True,
                 "SIMCORE_VCS_RELEASE_URL": True,
                 "SWARM_STACK_NAME": True,
-                "WEBSERVER_LICENSES": True,
                 "WEBSERVER_LOGIN": {
                     "LOGIN_ACCOUNT_DELETION_RETENTION_DAYS",
                     "LOGIN_2FA_REQUIRED",

services/web/server/src/simcore_service_webserver/licenses/_itis_vip_syncer_service.py

@@ -1,11 +1,11 @@
 import asyncio
+import datetime
 import logging
 from datetime import timedelta
 
 from aiohttp import web
 from httpx import AsyncClient
 from models_library.licenses import LicensedResourceType
-from pydantic import ValidationError
 from servicelib.async_utils import cancel_wait_task
 from servicelib.background_task_utils import exclusive_periodic
 from servicelib.logging_utils import log_catch, log_context
@@ -89,46 +89,42 @@ async def sync_resources_with_licensed_items(
 _BACKGROUND_TASK_NAME = f"{__name__}.itis_vip_syncer_cleanup_ctx._periodic_sync"
 
 
-def setup_itis_vip_syncer(app: web.Application):
-    categories = []
+def setup_itis_vip_syncer(
+    app: web.Application, settings: ItisVipSettings, resync_after: datetime.timedelta
+):
+    categories = settings.to_categories()
+    if not categories:
+        _logger.warning(
+            "Skipping setup_itis_vip_syncer. %s did not provide any category", settings
+        )
+        return
 
-    try:
-        settings = ItisVipSettings.create_from_envs()
-        categories = settings.to_categories()
+    setup_redis(app)
 
-    except ValidationError as err:
-        _logger.warning("IT'IS VIP syncer disabled. Skipping. %s", err)
-        return
+    async def _lifespan(app_: web.Application):
+        with (
+            log_context(
+                _logger,
+                logging.INFO,
+                f"IT'IS VIP syncing {len(categories)} categories",
+            ),
+            log_catch(_logger, reraise=False),
+        ):
 
-    if categories:
-
-        async def _cleanup_ctx(app_: web.Application):
-            with (
-                log_context(
-                    _logger,
-                    logging.INFO,
-                    f"IT'IS VIP syncing {len(categories)} categories",
-                ),
-                log_catch(_logger, reraise=False),
-            ):
-
-                @exclusive_periodic(
-                    get_redis_lock_manager_client_sdk(app_),
-                    task_interval=timedelta(minutes=1),
-                    retry_after=timedelta(minutes=2),
-                )
-                async def _periodic_sync() -> None:
-                    await sync_resources_with_licensed_items(
-                        app_, categories=categories
-                    )
+            @exclusive_periodic(
+                get_redis_lock_manager_client_sdk(app_),
+                task_interval=resync_after,
+                retry_after=timedelta(minutes=2),
+            )
+            async def _periodic_sync() -> None:
+                await sync_resources_with_licensed_items(app_, categories=categories)
 
-                background_task = asyncio.create_task(
-                    _periodic_sync(), name=_BACKGROUND_TASK_NAME
-                )
+            background_task = asyncio.create_task(
+                _periodic_sync(), name=_BACKGROUND_TASK_NAME
+            )
 
-                yield
+            yield
 
-                await cancel_wait_task(background_task)
+            await cancel_wait_task(background_task)
 
-        setup_redis(app)
-        app.cleanup_ctx.append(_cleanup_ctx)
+    app.cleanup_ctx.append(_lifespan)

services/web/server/src/simcore_service_webserver/licenses/plugin.py

@@ -16,6 +16,7 @@
     _licensed_items_rest,
     _rpc,
 )
+from .settings import LicensesSettings, get_plugin_settings
 
 _logger = logging.getLogger(__name__)
 
@@ -27,7 +28,7 @@
     logger=_logger,
 )
 def setup_licenses(app: web.Application):
-    assert app[APP_SETTINGS_KEY].WEBSERVER_LICENSES  # nosec
+    settings: LicensesSettings = get_plugin_settings(app)
 
     # routes
     setup_rest(app)
@@ -39,5 +40,9 @@ def setup_licenses(app: web.Application):
     if app[APP_SETTINGS_KEY].WEBSERVER_RABBITMQ:
         app.on_startup.append(_rpc.register_rpc_routes_on_startup)
 
-    # TODO: this is temporary
-    _itis_vip_syncer_service.setup_itis_vip_syncer(app)
+    if settings.LICENSES_ITIS_VIP_SYNCER_ENABLED and settings.LICENSES_ITIS_VIP:
+        _itis_vip_syncer_service.setup_itis_vip_syncer(
+            app,
+            settings=settings.LICENSES_ITIS_VIP,
+            resync_after=settings.LICENSES_ITIS_VIP_SYNCER_PERIODICITY,
+        )

services/web/server/src/simcore_service_webserver/licenses/settings.py

@@ -1,19 +1,29 @@
 import datetime
 from typing import Annotated
 
+from aiohttp import web
 from pydantic import Field
+from servicelib.aiohttp.application_keys import APP_SETTINGS_KEY
 from settings_library.base import BaseCustomSettings
 
 from ._itis_vip_settings import ItisVipSettings
 
 
 class LicensesSettings(BaseCustomSettings):
-    LICENSES_SYNCER_ENABLED: bool
-    LICENSES_SYNCER_PERIODICITY: datetime.timedelta
-
-    # Registered licensed resources:
+    # ITIS - VIP
     LICENSES_ITIS_VIP: Annotated[
         ItisVipSettings | None, Field(description="Settings for VIP license models")
     ]
+    LICENSES_ITIS_VIP_SYNCER_ENABLED: bool = False
+    LICENSES_ITIS_VIP_SYNCER_PERIODICITY: datetime.timedelta = datetime.timedelta(
+        days=1
+    )
 
     # other licensed resources come here ...
+
+
+def get_plugin_settings(app: web.Application) -> LicensesSettings:
+    settings = app[APP_SETTINGS_KEY].WEBSERVER_LICENSES
+    assert settings, "setup_settings not called?"  # nosec
+    assert isinstance(settings, LicensesSettings)  # nosec
+    return settings