♻️ Exposes to front-end whether payment plugin is enabled (⚠️ ops) (#4794)

Author: pcrespov

.env-devel

@@ -66,10 +66,11 @@ INVITATIONS_USERNAME=admin
 
 LOG_FORMAT_LOCAL_DEV_ENABLED=1
 
+WEBSERVER_PAYMENTS={}
 PAYMENTS_ACCESS_TOKEN_EXPIRE_MINUTES=30
 PAYMENTS_ACCESS_TOKEN_SECRET_KEY=2c0411810565e063309be1457009fb39ce023946f6a354e6935107b57676
 PAYMENTS_FAKE_COMPLETION_DELAY_SEC=10
-PAYMENTS_FAKE_COMPLETION=0 # NOTE: this can be 1 ONLY if WEBSERVER_DEV_FEATURES_ENABLED=1
+PAYMENTS_FAKE_COMPLETION=0
 PAYMENTS_GATEWAY_API_KEY=replace-with-api-key
 PAYMENTS_GATEWAY_API_SECRET=replace-with-api-secret
 PAYMENTS_GATEWAY_URL=https://fake-payment-gateway.com

packages/models-library/src/models_library/utils/string_substitution.py

@@ -5,9 +5,9 @@
 import sys
 from collections import UserDict
 from string import Template
-from typing import Any
+from typing import Any, Final
 
-OSPARC_IDENTIFIER_PREFIX = "OSPARC_VARIABLE_"
+OSPARC_IDENTIFIER_PREFIX: Final[str] = "OSPARC_VARIABLE_"
 
 
 def upgrade_identifier(identifier: str) -> str:

services/docker-compose.yml

@@ -386,7 +386,7 @@ services:
       TWILIO_AUTH_TOKEN: ${TWILIO_AUTH_TOKEN}
       TWILIO_COUNTRY_CODES_W_ALPHANUMERIC_SID_SUPPORT: ${TWILIO_COUNTRY_CODES_W_ALPHANUMERIC_SID_SUPPORT}
 
-      # WEBSERVER_PAYMENTS
+      WEBSERVER_PAYMENTS: ${WEBSERVER_PAYMENTS}
       PAYMENTS_FAKE_COMPLETION_DELAY_SEC: ${PAYMENTS_FAKE_COMPLETION_DELAY_SEC}
       PAYMENTS_FAKE_COMPLETION: ${PAYMENTS_FAKE_COMPLETION}
       PAYMENTS_FAKE_GATEWAY_URL: ${PAYMENTS_GATEWAY_URL}

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

@@ -296,7 +296,6 @@ def is_enabled(self, field_name: str) -> bool:
         return bool(getattr(self, field_name, None))
 
     def _get_disabled_public_plugins(self) -> list[str]:
-        plugins_disabled = []
         # NOTE: this list is limited for security reasons. An unbounded list
         # might reveal critical info on the settings of a deploy to the client.
         # TODO: more reliable definition of a "plugin" and whether it can be advertised or not
@@ -305,13 +304,15 @@ def _get_disabled_public_plugins(self) -> list[str]:
             "WEBSERVER_CLUSTERS",
             "WEBSERVER_EXPORTER",
             "WEBSERVER_META_MODELING",
+            "WEBSERVER_PAYMENTS",
             "WEBSERVER_SCICRUNCH",
             "WEBSERVER_VERSION_CONTROL",
         }
-        for field_name in PUBLIC_PLUGIN_CANDIDATES:
-            if not self.is_enabled(field_name):
-                plugins_disabled.append(field_name)
-        return plugins_disabled
+        return [
+            plugin_name
+            for plugin_name in PUBLIC_PLUGIN_CANDIDATES
+            if not self.is_enabled(plugin_name)
+        ]
 
     def _export_by_alias(self, **kwargs) -> dict[str, Any]:
         #  This is a small helper to assist export functions since aliases are no longer used by

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

@@ -5,20 +5,24 @@
 # refactoring would report very little. E.g. many test fixtures were based on given configs
 #
 
+import functools
 import logging
 from typing import Any
 
+from aiohttp import web
 from pydantic.types import SecretStr
+from servicelib.aiohttp.typing_extension import Handler
 
-from .application_settings import ApplicationSettings
+from ._constants import MSG_UNDER_DEVELOPMENT
+from .application_settings import ApplicationSettings, get_settings
 
 _logger = logging.getLogger(__name__)
 
 
 def convert_to_app_config(app_settings: ApplicationSettings) -> dict[str, Any]:
     """Maps current ApplicationSettings object into former trafaret-based config"""
 
-    cfg = {
+    return {
         "version": "1.0",
         "main": {
             "host": app_settings.WEBSERVER_SERVER_HOST,
@@ -33,7 +37,6 @@ def convert_to_app_config(app_settings: ApplicationSettings) -> dict[str, Any]:
         },
         "tracing": {
             "enabled": 1 if app_settings.WEBSERVER_TRACING is not None else 0,
-            #     "zipkin_endpoint": f"{getattr(app_settings.WEBSERVER_TRACING, 'TRACING_ZIPKIN_ENDPOINT', None)}",
         },
         "socketio": {"enabled": app_settings.WEBSERVER_SOCKETIO},
         "db": {
@@ -166,14 +169,17 @@ def convert_to_app_config(app_settings: ApplicationSettings) -> dict[str, Any]:
         "wallets": {"enabled": app_settings.WEBSERVER_WALLETS},
     }
 
-    return cfg
 
+def convert_to_environ_vars(  # noqa: C901, PLR0915, PLR0912
+    cfg: dict[str, Any]
+) -> dict[str, Any]:
+    """Creates envs dict out of config dict
 
-def convert_to_environ_vars(cfg: dict[str, Any]) -> dict[str, Any]:
-    """Creates envs dict out of config dict"""
-    # NOTE: maily used for testing traferet vs settings_library
+    NOTE: ONLY used to support legacy introduced by traferet vs settings_library.
+    """
     # pylint:disable=too-many-branches
     # pylint:disable=too-many-statements
+
     envs = {}
 
     def _set_if_disabled(field_name, section):
@@ -182,9 +188,8 @@ def _set_if_disabled(field_name, section):
         field = ApplicationSettings.__fields__[field_name]
         if not enabled:
             envs[field_name] = "null" if field.allow_none else "0"
-        else:
-            if field.type_ == bool:
-                envs[field_name] = "1"
+        elif field.type_ == bool:
+            envs[field_name] = "1"
 
     if main := cfg.get("main"):
         envs["WEBSERVER_PORT"] = main.get("port")
@@ -193,7 +198,6 @@ def _set_if_disabled(field_name, section):
 
     if section := cfg.get("tracing"):
         _set_if_disabled("WEBSERVER_TRACING", section)
-        # envs["TRACING_ZIPKIN_ENDPOINT"] = section.get("zipkin_endpoint")
 
     if db := cfg.get("db"):
         if section := db.get("postgres"):
@@ -312,3 +316,19 @@ def _set_if_disabled(field_name, section):
 
     # NOTE: The final envs list prunes all env vars set to None
     return {k: v for k, v in envs.items() if v is not None}
+
+
+#
+# decorators
+#
+
+
+def requires_dev_feature_enabled(handler: Handler):
+    @functools.wraps(handler)
+    async def _handler_under_dev(request: web.Request):
+        app_settings = get_settings(request.app)
+        if not app_settings.WEBSERVER_DEV_FEATURES_ENABLED:
+            raise NotImplementedError(MSG_UNDER_DEVELOPMENT)
+        return await handler(request)
+
+    return _handler_under_dev

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

@@ -31,7 +31,6 @@ class PaymentsSettings(BaseCustomSettings, MixinServiceSettings):
     )
 
     # NOTE: PAYMENTS_FAKE_* settings are temporary until some features are moved to the payments service
-
     PAYMENTS_FAKE_COMPLETION: bool = Field(
         default=False, description="Enables fake completion. ONLY for testing purposes"
     )
@@ -68,9 +67,9 @@ def base_url(self) -> str:
 
     @validator("PAYMENTS_FAKE_COMPLETION")
     @classmethod
-    def check_dev_feature_enabled(cls, v):
-        if v and not os.environ.get("WEBSERVER_DEV_FEATURES_ENABLED", False):
-            msg = "PAYMENTS_FAKE_COMPLETION only allowed when WEBSERVER_DEV_FEATURES_ENABLED=1"
+    def _payments_cannot_be_faken_in_production(cls, v):
+        if v is True and "production" in os.environ.get("SWARM_STACK_NAME", ""):
+            msg = "PAYMENTS_FAKE_COMPLETION only allowed FOR TESTING PURPOSES and cannot be released to production"
             raise ValueError(msg)
         return v
 

services/web/server/src/simcore_service_webserver/resource_usage/_constants.py

@@ -1,3 +1,7 @@
 from typing import Final
 
 APP_RABBITMQ_CONSUMERS_KEY: Final[str] = f"{__name__}.rabbit_consumers"
+
+MSG_RESOURCE_USAGE_TRACKER_SERVICE_UNAVAILABLE: Final[
+    str
+] = "Currently resource usage tracker service is unavailable, please try again later"

services/web/server/src/simcore_service_webserver/resource_usage/_observer.py

@@ -2,7 +2,6 @@
 
 """
 
-# pylint: disable=unused-argument
 
 import logging
 
@@ -27,6 +26,9 @@ async def _on_user_disconnected(
     app: web.Application,
     product_name: ProductName,
 ) -> None:
+    assert product_name  # nosec
+    assert client_session_id  # nosec
+
     # Get all user wallets and unsubscribe
     user_wallet = await wallets_api.list_wallets_for_user(
         app, user_id=user_id, product_name=product_name

services/web/server/src/simcore_service_webserver/resource_usage/_utils.py

@@ -1,18 +1,15 @@
 import asyncio
 import logging
+from collections.abc import Iterator
 from contextlib import contextmanager
-from typing import Final, Iterator
 
 from aiohttp import ClientSession, web
 from aiohttp.client_exceptions import ClientConnectionError, ClientResponseError
 from servicelib.aiohttp.client_session import get_client_session
 
-_logger = logging.getLogger(__name__)
-
+from ._constants import MSG_RESOURCE_USAGE_TRACKER_SERVICE_UNAVAILABLE
 
-MSG_RESOURCE_USAGE_TRACKER_SERVICE_UNAVAILABLE: Final[
-    str
-] = "Currently resource usage tracker service is unavailable, please try again later"
+_logger = logging.getLogger(__name__)
 
 
 @contextmanager

services/web/server/src/simcore_service_webserver/resource_usage/resource_usage_tracker_client.py

@@ -51,6 +51,7 @@ async def list_service_runs_by_user_and_product(
 
 async def list_service_runs_by_user_and_product_and_wallet(
     app: web.Application,
+    *,
     user_id: UserID,
     product_name: str,
     wallet_id: WalletID,