refactored in the Routes__Info used in other projects

Author: DinisCruz

osbot_fast_api_serverless/__init__.py

@@ -1 +1,2 @@
+package_name = 'osbot_fast_api_serverless'
 path=__path__[0]

osbot_fast_api_serverless/fast_api/routes/Routes__Info.py

@@ -1,16 +1,38 @@
-from osbot_fast_api.api.routes.Fast_API__Routes     import Fast_API__Routes
-from osbot_fast_api_serverless.utils.Version        import version__osbot_fast_api_serverless
+from osbot_fast_api.api.routes.Fast_API__Routes           import Fast_API__Routes
+from osbot_fast_api_serverless.services.info.Service_Info import Service_Info
+from osbot_fast_api_serverless.utils.Version              import version__osbot_fast_api_serverless
 
-ROUTES_PATHS__INFO = ['/info/version']
+TAG__ROUTES_INFO                  = 'info'
+ROUTES_PATHS__INFO                = [ f'/{TAG__ROUTES_INFO}/health'  ,
+                                      f'/{TAG__ROUTES_INFO}/server'  ,
+                                      f'/{TAG__ROUTES_INFO}/status'  ,
+                                      f'/{TAG__ROUTES_INFO}/version' ,
+                                      f'/{TAG__ROUTES_INFO}/versions']
+ROUTES_INFO__HEALTH__RETURN_VALUE = {'status': 'ok'}
 
 class Routes__Info(Fast_API__Routes):
-    tag :str = 'info'
+    tag         : str          = 'info'
+    service_info: Service_Info
 
+    def health(self):
+        return ROUTES_INFO__HEALTH__RETURN_VALUE
+
+    def server(self):                                             # Get service versions
+        return self.service_info.server_info()
+
+    def status(self):                                               # Get service status information
+        return self.service_info.service_info()
+
+    def versions(self):                                             # Get service versions
+        return self.service_info.versions()                         # todo: this should also include the version from Fast_API
+                                                                    #       and see if this should not be inside the /server endpoint
 
     def version(self):
-        return {'version': version__osbot_fast_api_serverless}
+        return dict(version=version__osbot_fast_api_serverless )    # todo: fix this to get this value from FastAPI app object
 
-    
     def setup_routes(self):
-        self.add_route_get(self.version)
-
+        self.add_route_get(self.health  )
+        self.add_route_get(self.server  )
+        self.add_route_get(self.status  )
+        self.add_route_get(self.version )
+        self.add_route_get(self.versions)

osbot_fast_api_serverless/services/info/Service_Info.py

@@ -0,0 +1,24 @@
+from osbot_fast_api.utils.Fast_API__Server_Info                            import fast_api__server_info, Fast_API__Server_Info
+from osbot_fast_api_serverless.services.info.schemas.Enum__Service_Environment import Enum__Service_Environment
+from osbot_fast_api_serverless.services.info.schemas.Schema__Server__Versions import Schema__Server__Versions
+from osbot_fast_api_serverless.services.info.schemas.Schema__Service__Status import Schema__Service__Status
+from osbot_utils.type_safe.Type_Safe                                       import Type_Safe
+
+
+class Service_Info(Type_Safe):
+
+    def environment(self):                                                   # Determine current environment
+        import os
+        if os.getenv('AWS_REGION'):
+            return Enum__Service_Environment.aws_lambda
+        else:
+            return Enum__Service_Environment.local
+
+    def service_info(self) -> Schema__Service__Status:                               # Get current service status
+        return Schema__Service__Status(environment = self.environment())
+
+    def versions(self):
+        return Schema__Server__Versions()
+
+    def server_info(self) -> Fast_API__Server_Info:
+        return fast_api__server_info

osbot_fast_api_serverless/services/info/__init__.py

@@ -0,0 +1,6 @@
+from enum import Enum
+
+
+class Enum__Service_Environment(str, Enum):
+    aws_lambda = 'aws-lambda'
+    local      = 'local'

osbot_fast_api_serverless/services/info/schemas/Enum__Service_Environment.py

@@ -0,0 +1,5 @@
+from enum import Enum
+
+class Enum__Service_Status(str, Enum):
+    operational = 'operational'
+    degraded    = 'degraded'

osbot_fast_api_serverless/services/info/schemas/Enum__Service_Status.py

@@ -0,0 +1,13 @@
+from osbot_utils.type_safe.Type_Safe                                            import Type_Safe
+from osbot_utils.type_safe.primitives.domains.common.safe_str.Safe_Str__Version import Safe_Str__Version
+from osbot_utils.utils.Version                                                  import Version as Version__OSBot_Utils
+from osbot_aws.utils.Version                                                    import Version as Version__OSBot_AWS
+from osbot_fast_api.utils.Version                                               import version__osbot_fast_api
+from osbot_fast_api_serverless.utils.Version                                    import version__osbot_fast_api_serverless
+
+
+class Schema__Server__Versions(Type_Safe):
+    osbot_utils                 : Safe_Str__Version       = Safe_Str__Version(Version__OSBot_Utils().value()    )
+    osbot_aws                   : Safe_Str__Version       = Safe_Str__Version(Version__OSBot_AWS  ().value()    )
+    osbot_fast_api              : Safe_Str__Version       = Safe_Str__Version(version__osbot_fast_api           )
+    osbot_fast_api_serverless   : Safe_Str__Version       = Safe_Str__Version(version__osbot_fast_api_serverless)

osbot_fast_api_serverless/services/info/schemas/Schema__Server__Versions.py

@@ -0,0 +1,13 @@
+from osbot_fast_api_serverless                                                   import package_name
+from osbot_fast_api_serverless.services.info.schemas.Enum__Service_Environment   import Enum__Service_Environment
+from osbot_fast_api_serverless.services.info.schemas.Enum__Service_Status        import Enum__Service_Status
+from osbot_fast_api_serverless.utils.Version                                     import version__osbot_fast_api_serverless
+from osbot_utils.type_safe.Type_Safe                                             import Type_Safe
+from osbot_utils.type_safe.primitives.domains.common.safe_str.Safe_Str__Version  import Safe_Str__Version
+from osbot_utils.type_safe.primitives.domains.identifiers.Safe_Id                import Safe_Id
+
+class Schema__Service__Status(Type_Safe):
+    name        : Safe_Id                   = Safe_Id(package_name)
+    version     : Safe_Str__Version         = version__osbot_fast_api_serverless
+    status      : Enum__Service_Status      = Enum__Service_Status.operational
+    environment : Enum__Service_Environment = Enum__Service_Environment.local