refactor: replace ScicrunchResourcesService with SCICRUNCH_SERVICE_APPKEY for improved service integration

Author: pcrespov

services/web/server/src/simcore_service_webserver/exporter/_formatter/_sds.py

@@ -11,7 +11,7 @@
 from ...projects._projects_service import get_project_for_user
 from ...projects.exceptions import BaseProjectError
 from ...projects.models import ProjectDict
-from ...scicrunch.scicrunch_service import ScicrunchResourcesService
+from ...scicrunch.scicrunch_service import SCICRUNCH_SERVICE_APPKEY
 from ..exceptions import SDSException
 from .template_json import write_template_json
 from .xlsx.code_description import (
@@ -70,7 +70,7 @@ async def _add_rrid_entries(
 ) -> None:
     rrid_entires: deque[RRIDEntry] = deque()
 
-    service = ScicrunchResourcesService(app)
+    service = app[SCICRUNCH_SERVICE_APPKEY]
     classifiers = project_data["classifiers"]
     for classifier in classifiers:
         scicrunch_resource = await service.get_resource_atdb(rrid=classifier)

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

@@ -1,6 +1,7 @@
 import logging
 
 from aiohttp import web
+from simcore_service_webserver.scicrunch.plugin import setup_scicrunch
 
 from ..application_setup import ModuleCategory, app_setup_func
 from . import _handlers
@@ -19,4 +20,6 @@ def setup_exporter(app: web.Application) -> bool:
     # Rest-API routes: maps handlers with routes tags with "viewer" based on OAS operation_id
     app.router.add_routes(_handlers.routes)
 
+    setup_scicrunch(app)
+
     return True

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

@@ -24,7 +24,7 @@
 )
 
 from ..scicrunch.errors import ScicrunchError
-from ..scicrunch.scicrunch_service import ScicrunchResourcesService
+from ..scicrunch.scicrunch_service import SCICRUNCH_SERVICE_APPKEY
 from ._classifiers_repository import GroupClassifierRepository
 
 _logger = logging.getLogger(__name__)
@@ -119,7 +119,7 @@ async def _build_rrids_tree_view(
             msg = "Currently only 'std' option for the classifiers tree view is implemented"
             raise NotImplementedError(msg)
 
-        service = ScicrunchResourcesService(self.app)
+        service = self.app[SCICRUNCH_SERVICE_APPKEY]
 
         flat_tree_view: dict[TreePath, ClassifierItem] = {}
         for resource in await service.list_research_resources():

services/web/server/src/simcore_service_webserver/scicrunch/service_client.py renamed to services/web/server/src/simcore_service_webserver/scicrunch/_client.py

@@ -7,9 +7,9 @@
 from common_library.logging.logging_errors import create_troubleshooting_log_kwargs
 from pydantic import HttpUrl, ValidationError
 
+from ._client import SciCrunch
 from ._repository import ScicrunchResourcesRepository
 from .models import ResearchResource, ResearchResourceAtdB, ResourceHit
-from .service_client import SciCrunch
 
 _logger = logging.getLogger(__name__)
 

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

@@ -1,17 +1,13 @@
-"""
-Notice that this is used as a submodule of groups'a app module
-"""
-
 import logging
 
 from aiohttp import web
-from conftest import app
+from simcore_service_webserver.db.plugin import setup_db
 from simcore_service_webserver.scicrunch._repository import ScicrunchResourcesRepository
 
 from ..application_setup import ModuleCategory, app_setup_func
+from ._client import SciCrunch
 from ._service import ScicrunchResourcesService
 from .scicrunch_service import SCICRUNCH_SERVICE_APPKEY
-from .service_client import SciCrunch
 from .settings import get_plugin_settings
 
 _logger = logging.getLogger(__name__)
@@ -20,14 +16,21 @@
 async def _on_startup(app: web.Application):
     settings = get_plugin_settings(app)
 
+    # 1. scicrunch http client
     client = SciCrunch.acquire_instance(app, settings)
     assert client == SciCrunch.get_instance(app)  # nosec
 
+    # 2. scicrunch repository (uses app[ENGINE_DB_CLIENT_APPKEY])
+    repo = ScicrunchResourcesRepository.create_from_app(app)
+    assert repo  # nosec
+
+    # 3. scicrunch resources service
     service = ScicrunchResourcesService(
-        repo=ScicrunchResourcesRepository.create_from_app(app),
-        client=SciCrunch.get_instance(app),
+        repo=repo,
+        client=client,
     )
 
+    # store service in app
     app[SCICRUNCH_SERVICE_APPKEY] = service
 
 
@@ -40,4 +43,6 @@ async def _on_startup(app: web.Application):
 def setup_scicrunch(app: web.Application):
     assert get_plugin_settings(app)  # nosec
 
+    setup_db(app)  # needs engine
+
     app.on_startup.append(_on_startup)

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

@@ -19,13 +19,13 @@
 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.service_client import (
+from simcore_service_webserver.scicrunch._client import (
     ResearchResource,
     SciCrunch,
 )
+from simcore_service_webserver.scicrunch.plugin import (
+    setup_scicrunch,
+)
 
 
 @pytest.fixture