refactor: update scicrunch service integration and improve dependency management

Author: pcrespov

services/web/server/src/simcore_service_webserver/groups/_classifiers_rest.py

@@ -9,7 +9,7 @@
 from .._meta import API_VTAG
 from ..login.decorators import login_required
 from ..scicrunch.models import ResourceHit
-from ..scicrunch.scicrunch_service import ScicrunchResourcesService
+from ..scicrunch.scicrunch_service import SCICRUNCH_SERVICE_APPKEY
 from ..security.decorators import permission_required
 from ..utils_aiohttp import envelope_json_response
 from ._classifiers_service import GroupClassifiersService
@@ -50,7 +50,7 @@ async def get_group_classifiers(request: web.Request):
 async def get_scicrunch_resource(request: web.Request):
     rrid = request.match_info["rrid"]
 
-    service = ScicrunchResourcesService(request.app)
+    service = request.app[SCICRUNCH_SERVICE_APPKEY]
     resource = await service.get_or_fetch_research_resource(rrid)
 
     return envelope_json_response(resource.model_dump())
@@ -66,7 +66,7 @@ async def get_scicrunch_resource(request: web.Request):
 async def add_scicrunch_resource(request: web.Request):
     rrid = request.match_info["rrid"]
 
-    service = ScicrunchResourcesService(request.app)
+    service = request.app[SCICRUNCH_SERVICE_APPKEY]
     resource = await service.create_research_resource(rrid)
 
     return envelope_json_response(resource.model_dump())
@@ -82,7 +82,7 @@ async def add_scicrunch_resource(request: web.Request):
 async def search_scicrunch_resources(request: web.Request):
     guess_name = str(request.query["guess_name"]).strip()
 
-    service = ScicrunchResourcesService(request.app)
+    service = request.app[SCICRUNCH_SERVICE_APPKEY]
     hits: list[ResourceHit] = await service.search_research_resources(guess_name)
 
     return envelope_json_response([hit.model_dump() for hit in hits])

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

@@ -1,6 +1,7 @@
 import logging
 
 from aiohttp import web
+from simcore_service_webserver.scicrunch.plugin import setup_scicrunch
 
 from ..application_keys import APP_SETTINGS_APPKEY
 from ..application_setup import ModuleCategory, app_setup_func
@@ -22,6 +23,7 @@ def setup_groups(app: web.Application):
 
     # plugin dependencies
     setup_products(app)
+    setup_scicrunch(app)
 
     app.router.add_routes(_groups_rest.routes)
     app.router.add_routes(_classifiers_rest.routes)

services/web/server/src/simcore_service_webserver/scicrunch/_service.py

@@ -4,7 +4,6 @@
 
 import logging
 
-from aiohttp import web
 from common_library.logging.logging_errors import create_troubleshooting_log_kwargs
 from pydantic import HttpUrl, ValidationError
 
@@ -21,11 +20,10 @@ class ScicrunchResourcesService:
     - Research Resources operations (RRID = Research Resource ID)
     """
 
-    def __init__(self, app: web.Application):
-        self.app = app
-        self._repo = ScicrunchResourcesRepository.create_from_app(app)
+    def __init__(self, repo: ScicrunchResourcesRepository, client: SciCrunch):
+        self._repo = repo
         # client to interact with scicrunch.org service
-        self._client = SciCrunch.get_instance(self.app)
+        self._client = client
 
     async def list_research_resources(self) -> list[ResearchResource]:
         """List all research resources as domain models."""

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

@@ -5,8 +5,12 @@
 import logging
 
 from aiohttp import web
+from conftest import app
+from simcore_service_webserver.scicrunch._repository import ScicrunchResourcesRepository
 
 from ..application_setup import ModuleCategory, app_setup_func
+from ._service import ScicrunchResourcesService
+from .scicrunch_service import SCICRUNCH_SERVICE_APPKEY
 from .service_client import SciCrunch
 from .settings import get_plugin_settings
 
@@ -15,8 +19,16 @@
 
 async def _on_startup(app: web.Application):
     settings = get_plugin_settings(app)
-    api = SciCrunch.acquire_instance(app, settings)
-    assert api == SciCrunch.get_instance(app)  # nosec
+
+    client = SciCrunch.acquire_instance(app, settings)
+    assert client == SciCrunch.get_instance(app)  # nosec
+
+    service = ScicrunchResourcesService(
+        repo=ScicrunchResourcesRepository.create_from_app(app),
+        client=SciCrunch.get_instance(app),
+    )
+
+    app[SCICRUNCH_SERVICE_APPKEY] = service
 
 
 @app_setup_func(

services/web/server/src/simcore_service_webserver/scicrunch/scicrunch_service.py

@@ -1,4 +1,13 @@
+from typing import Final
+
+from aiohttp import web
+
 from ._service import ScicrunchResourcesService
 
-__all__: tuple[str, ...] = ("ScicrunchResourcesService",)
+SCICRUNCH_SERVICE_APPKEY: Final = web.AppKey(
+    ScicrunchResourcesService.__name__, ScicrunchResourcesService
+)
+
+
+__all__: tuple[str, ...] = ("SCICRUNCH_SERVICE_APPKEY",)
 # nopycln: file

services/web/server/src/simcore_service_webserver/scicrunch/service_client.py

@@ -61,15 +61,15 @@ def acquire_instance(
         cls, app: web.Application, settings: SciCrunchSettings
     ) -> "SciCrunch":
         """Returns single instance for the application and stores it"""
-        obj: SciCrunch | None = app.get(_SCICRUNCH_APPKEY)
+        obj: SciCrunch | None = app.get(SCICRUNCH_CLIENT_APPKEY)
         if obj is None:
             session = get_client_session(app)
-            app[_SCICRUNCH_APPKEY] = obj = cls(session, settings)
+            app[SCICRUNCH_CLIENT_APPKEY] = obj = cls(session, settings)
         return obj
 
     @classmethod
     def get_instance(cls, app: web.Application) -> "SciCrunch":
-        obj: SciCrunch | None = app.get(_SCICRUNCH_APPKEY)
+        obj: SciCrunch | None = app.get(SCICRUNCH_CLIENT_APPKEY)
         if obj is None:
             raise ScicrunchConfigError(
                 details="Services on scicrunch.org are currently disabled"
@@ -174,4 +174,4 @@ async def search_resource(self, name_as: str) -> list[ResourceHit]:
         return hits.root
 
 
-_SCICRUNCH_APPKEY: Final = web.AppKey(SciCrunch.__name__, SciCrunch)
+SCICRUNCH_CLIENT_APPKEY: Final = web.AppKey(SciCrunch.__name__, SciCrunch)

services/web/server/tests/unit/isolated/scicrunch/test_scicrunch_service_client.py

@@ -19,7 +19,9 @@
 from servicelib.aiohttp.application import create_safe_application
 from servicelib.aiohttp.client_session import get_client_session
 from simcore_service_webserver.application_settings import setup_settings
-from simcore_service_webserver.scicrunch.plugin import setup_scicrunch
+from simcore_service_webserver.scicrunch.plugin import (
+    setup_scicrunch,
+)
 from simcore_service_webserver.scicrunch.service_client import (
     ResearchResource,
     SciCrunch,