Deprecate Service module

Author: jenniferjiangkells

healthchain/gateway/api/app.py

@@ -8,15 +8,19 @@
 import logging
 import importlib
 import inspect
+import os
+import signal
 
 from datetime import datetime
 from fastapi import FastAPI, APIRouter, HTTPException, Request
 from fastapi.middleware.cors import CORSMiddleware
 from fastapi.middleware.wsgi import WSGIMiddleware
 from fastapi.exceptions import RequestValidationError
 from fastapi.responses import JSONResponse
+from contextlib import asynccontextmanager
+from termcolor import colored
 
-from typing import Dict, Optional, Type, Union, Set, ForwardRef
+from typing import Dict, Optional, Type, Union, Set
 
 from healthchain.gateway.core.base import BaseGateway
 from healthchain.gateway.events.dispatcher import EventDispatcher
@@ -25,10 +29,6 @@
 logger = logging.getLogger(__name__)
 
 
-# Forward reference for type hints
-HealthChainAPIRef = ForwardRef("HealthChainAPI")
-
-
 class HealthChainAPI(FastAPI):
     """
     HealthChainAPI wraps FastAPI to provide healthcare-specific integrations.
@@ -83,6 +83,10 @@ def __init__(
             event_dispatcher: Optional event dispatcher to use (for testing/DI)
             **kwargs: Additional keyword arguments to pass to FastAPI
         """
+        # Set up the lifespan
+        if "lifespan" not in kwargs:
+            kwargs["lifespan"] = self.lifespan
+
         super().__init__(
             title=title, description=description, version=version, **kwargs
         )
@@ -122,6 +126,13 @@ def __init__(
         # Register self as a dependency for get_app
         self.dependency_overrides[get_app] = lambda: self
 
+        # Add a shutdown route
+        shutdown_router = APIRouter()
+        shutdown_router.add_api_route(
+            "/shutdown", self._shutdown, methods=["GET"], include_in_schema=False
+        )
+        self.include_router(shutdown_router)
+
     def get_event_dispatcher(self) -> Optional[EventDispatcher]:
         """Get the event dispatcher instance.
 
@@ -233,7 +244,7 @@ def _add_gateway_routes(
                         self.gateway_endpoints[gateway_name].add(
                             f"{method}:{route_path}"
                         )
-                        logger.info(
+                        logger.debug(
                             f"Registered {method} route {route_path} for {gateway_name}"
                         )
 
@@ -257,7 +268,7 @@ def _add_gateway_routes(
             # Mount the WSGI app
             self.mount(mount_path, WSGIMiddleware(wsgi_app))
             self.gateway_endpoints[gateway_name].add(f"WSGI:{mount_path}")
-            logger.info(f"Registered WSGI gateway {gateway_name} at {mount_path}")
+            logger.debug(f"Registered WSGI gateway {gateway_name} at {mount_path}")
 
         # Case 3: Gateway instances that are also APIRouters (like FHIRGateway)
         elif isinstance(gateway, APIRouter):
@@ -269,11 +280,11 @@ def _add_gateway_routes(
                         self.gateway_endpoints[gateway_name].add(
                             f"{method}:{route.path}"
                         )
-                        logger.info(
+                        logger.debug(
                             f"Registered {method} route {route.path} from {gateway_name} router"
                         )
             else:
-                logger.info(f"Registered {gateway_name} as router (routes unknown)")
+                logger.debug(f"Registered {gateway_name} as router (routes unknown)")
 
         elif not (
             hasattr(gateway, "get_routes")
@@ -282,15 +293,23 @@ def _add_gateway_routes(
         ):
             logger.warning(f"Gateway {gateway_name} does not provide any routes")
 
-    def register_router(self, router: Union[APIRouter, Type, str], **options) -> None:
+    def register_router(
+        self, router: Union[APIRouter, Type, str, list], **options
+    ) -> None:
         """
-        Register a router with the API.
+        Register one or more routers with the API.
 
         Args:
-            router: The router to register (can be an instance, class, or import path)
+            router: The router(s) to register (can be an instance, class, import path, or list of any of these)
             **options: Options to pass to the router constructor or include_router
         """
         try:
+            # Handle list of routers
+            if isinstance(router, list):
+                for r in router:
+                    self.register_router(r, **options)
+                return
+
             # Case 1: Direct APIRouter instance
             if isinstance(router, APIRouter):
                 self.include_router(router, **options)
@@ -403,6 +422,47 @@ async def _general_exception_handler(
             content={"detail": "Internal server error"},
         )
 
+    @asynccontextmanager
+    async def lifespan(self, app: FastAPI):
+        """Lifecycle manager for the application."""
+        self._startup()
+        yield
+        self._shutdown()
+
+    def _startup(self) -> None:
+        """Display startup information and log registered endpoints."""
+        healthchain_ascii = r"""
+
+    __  __           ____  __    ________          _
+   / / / /__  ____ _/ / /_/ /_  / ____/ /_  ____ _(_)___
+  / /_/ / _ \/ __ `/ / __/ __ \/ /   / __ \/ __ `/ / __ \
+ / __  /  __/ /_/ / / /_/ / / / /___/ / / / /_/ / / / / /
+/_/ /_/\___/\__,_/_/\__/_/ /_/\____/_/ /_/\__,_/_/_/ /_/
+
+"""  # noqa: E501
+
+        colors = ["red", "yellow", "green", "cyan", "blue", "magenta"]
+        for i, line in enumerate(healthchain_ascii.split("\n")):
+            color = colors[i % len(colors)]
+            print(colored(line, color))
+
+        # Log registered gateways and endpoints
+        for name, gateway in self.gateways.items():
+            endpoints = self.gateway_endpoints.get(name, set())
+            for endpoint in endpoints:
+                print(f"{colored('HEALTHCHAIN', 'green')}: {endpoint}")
+
+        print(
+            f"{colored('HEALTHCHAIN', 'green')}: See more details at {colored(self.docs_url, 'magenta')}"
+        )
+
+    def _shutdown(self):
+        """
+        Shuts down server by sending a SIGTERM signal.
+        """
+        os.kill(os.getpid(), signal.SIGTERM)
+        return JSONResponse(content={"message": "Server is shutting down..."})
+
 
 def create_app(
     config: Optional[Dict] = None,

healthchain/gateway/protocols/__init__.py

@@ -11,9 +11,11 @@
 from .fhirgateway import FHIRGateway
 from .cdshooks import CDSHooksGateway
 from .notereader import NoteReaderGateway
+from .apiprotocol import ApiProtocol
 
 __all__ = [
     "FHIRGateway",
     "CDSHooksGateway",
     "NoteReaderGateway",
+    "ApiProtocol",
 ]

healthchain/gateway/protocols/apiprotocol.py

@@ -0,0 +1,14 @@
+from enum import Enum
+
+
+class ApiProtocol(Enum):
+    """
+    Enum defining the supported API protocols.
+
+    Available protocols:
+    - soap: SOAP protocol
+    - rest: REST protocol
+    """
+
+    soap = "SOAP"
+    rest = "REST"

healthchain/gateway/protocols/notereader.py

@@ -17,11 +17,11 @@
 from healthchain.gateway.events.dispatcher import EHREvent, EHREventType
 from healthchain.gateway.core.base import BaseGateway
 from healthchain.gateway.events.dispatcher import EventDispatcher
-from healthchain.service.soap.epiccdsservice import CDSServices
+from healthchain.gateway.soap.epiccdsservice import CDSServices
 from healthchain.models.requests import CdaRequest
 from healthchain.models.responses.cdaresponse import CdaResponse
-from healthchain.service.soap.model.epicclientfault import ClientFault
-from healthchain.service.soap.model.epicserverfault import ServerFault
+from healthchain.gateway.soap.model.epicclientfault import ClientFault
+from healthchain.gateway.soap.model.epicserverfault import ServerFault
 from healthchain.gateway.api.protocols import SOAPGatewayProtocol
 
 logger = logging.getLogger(__name__)

…althchain/service/soap/epiccdsservice.py …althchain/gateway/soap/epiccdsservice.pyhealthchain/service/soap/epiccdsservice.py renamed to healthchain/gateway/soap/epiccdsservice.py healthchain/service/soap/epiccdsservice.py renamed to healthchain/gateway/soap/epiccdsservice.py

@@ -4,8 +4,8 @@
 
 from typing import Callable
 
-from healthchain.service.soap.epiccdsservice import CDSServices
-from healthchain.service.soap.model import ClientFault, ServerFault
+from healthchain.gateway.soap.epiccdsservice import CDSServices
+from healthchain.gateway.soap.model import ClientFault, ServerFault
 
 
 def start_wsgi(