Merge pull request #100 from Point72/tkp/consis

Add consistency for web routes

Author: timkpaine

csp_gateway/server/modules/controls/controls.py

@@ -7,7 +7,6 @@
 import csp
 import psutil
 from csp import ts
-from fastapi import FastAPI
 
 from csp_gateway.server import GatewayChannels, GatewayModule
 
@@ -20,16 +19,27 @@
 
 
 class MountControls(GatewayModule):
-    app: GatewayWebApp = None
-    fastapi: FastAPI = None
+    mount_heartbeat: bool = True
+    mount_stats: bool = True
+    mount_shutdown: bool = True
 
     def connect(self, channels: GatewayChannels) -> None:
         self.subscribe(channels.get_channel("controls"))
         channels.add_send_channel("controls")
 
     def rest(self, app: GatewayWebApp) -> None:
-        self.app = app
-        self.fastapi = app.get_fastapi()
+        available = []
+        if self.mount_heartbeat:
+            app.add_controls_api(field="heartbeat")
+            available.append("heartbeat")
+        if self.mount_stats:
+            app.add_controls_api(field="stats")
+            available.append("stats")
+        if self.mount_shutdown:
+            app.add_controls_api(field="shutdown")
+            available.append("shutdown")
+
+        app.add_controls_available_channels(fields=set(available))
 
     @csp.node
     def manage_controls(self, data: ts[Controls]):

csp_gateway/server/modules/web/mount.py

@@ -16,11 +16,11 @@ class MountRestRoutes(GatewayModule):
         description="For debugging, will mount all rest routes for every channel, including state and send routes, even if not added by any modules",
     )
 
-    mount_last: ChannelSelection = ChannelSelection()
-    mount_next: ChannelSelection = ChannelSelection()
-    mount_send: ChannelSelection = ChannelSelection()
-    mount_state: ChannelSelection = ChannelSelection()
-    mount_lookup: ChannelSelection = ChannelSelection()
+    mount_last: ChannelSelection = Field(default_factory=ChannelSelection, description="Channels to mount for last operations. Defaults to all")
+    mount_next: ChannelSelection = Field(default_factory=ChannelSelection, description="Channels to mount for next operations. Defaults to all")
+    mount_send: ChannelSelection = Field(default_factory=ChannelSelection, description="Channels to mount for send operations. Defaults to all")
+    mount_state: ChannelSelection = Field(default_factory=ChannelSelection, description="Channels to mount for state operations. Defaults to all")
+    mount_lookup: ChannelSelection = Field(default_factory=ChannelSelection, description="Channels to mount for lookup operations. Defaults to all")
 
     @model_validator(mode="before")
     @classmethod
@@ -51,7 +51,7 @@ def _mount_last(self, app: GatewayWebApp) -> None:
             # Install on router
             app.add_last_api(name)
 
-        app.add_last_api_available_channels(channels_set)
+        app.add_last_available_channels(channels_set)
 
     def _mount_next(self, app: GatewayWebApp) -> None:
         selection = ChannelSelection() if self.force_mount_all else self.mount_next
@@ -62,7 +62,7 @@ def _mount_next(self, app: GatewayWebApp) -> None:
             # Install on router
             app.add_next_api(name)
 
-        app.add_next_api_available_channels(channels_set)
+        app.add_next_available_channels(channels_set)
 
     def _mount_send(self, app: GatewayWebApp) -> None:
         selection = ChannelSelection() if self.force_mount_all else self.mount_send
@@ -87,7 +87,7 @@ def _mount_send(self, app: GatewayWebApp) -> None:
             if missing_channels:
                 log.info(f"Requested channels missing send routes are: {list(missing_channels)}")
 
-        app.add_send_api_available_channels(seen_channels)
+        app.add_send_available_channels(seen_channels)
 
     def _mount_state(self, app: GatewayWebApp) -> None:
         selection = ChannelSelection() if self.force_mount_all else self.mount_state
@@ -112,11 +112,15 @@ def _mount_state(self, app: GatewayWebApp) -> None:
             if missing_channels:
                 log.info(f"Requested channels missing state routes: {list(channel[2:] for channel in missing_channels)}")
 
-        app.add_state_api_available_channels(seen_channels)
+        app.add_state_available_channels(seen_channels)
 
     def _mount_lookup(self, app: GatewayWebApp) -> None:
         selection = ChannelSelection() if self.force_mount_all else self.mount_lookup
+        channels_set = set(selection.select_from(app.gateway.channels_model))
+
         # Bind every wire
         for name in selection.select_from(app.gateway.channels_model):
             # Install on router
             app.add_lookup_api(name)
+
+        app.add_lookup_available_channels(channels_set)

csp_gateway/server/settings.py

@@ -17,7 +17,7 @@ class Settings(BaseSettings):
 
     model_config = dict(case_sensitive=True)
 
-    API_V1_STR: str = "/api/v1"
+    API_STR: str = "/api/v1"
     BACKEND_CORS_ORIGINS: List[AnyHttpUrl] = []
 
     TITLE: str = "Gateway"

csp_gateway/server/web/app.py

@@ -28,15 +28,17 @@
 )
 
 from .routes import (
+    add_controls_available_channels,
     add_controls_routes,
-    add_last_api_available_channels,
+    add_last_available_channels,
     add_last_routes,
+    add_lookup_available_channels,
     add_lookup_routes,
-    add_next_api_available_channels,
+    add_next_available_channels,
     add_next_routes,
-    add_send_api_available_channels,
+    add_send_available_channels,
     add_send_routes,
-    add_state_api_available_channels,
+    add_state_available_channels,
     add_state_routes,
 )
 from .static import CacheControlledStaticFiles
@@ -285,7 +287,7 @@ def add_api(self) -> None:
 
         self.app.include_router(
             api_router,
-            prefix=self.settings.API_V1_STR,
+            prefix=self.settings.API_STR,
             dependencies=self._middlewares,
         )
 
@@ -326,9 +328,9 @@ def add_last_api(self, field: str) -> None:
 
         add_last_routes(api_router=api_router, field=field, model=model, subroute_key=subroute_key)
 
-    def add_last_api_available_channels(self, fields: Optional[Set[str]] = None) -> None:
+    def add_last_available_channels(self, fields: Optional[Set[str]] = None) -> None:
         api_router = self.get_router("last")
-        add_last_api_available_channels(api_router=api_router, fields=fields)
+        add_last_available_channels(api_router=api_router, fields=fields)
 
     def add_next_api(self, field: str) -> None:
         api_router = self.get_router("next")
@@ -342,9 +344,9 @@ def add_next_api(self, field: str) -> None:
 
         add_next_routes(api_router=api_router, field=field, model=model, subroute_key=subroute_key)
 
-    def add_next_api_available_channels(self, fields: Optional[Set[str]] = None) -> None:
+    def add_next_available_channels(self, fields: Optional[Set[str]] = None) -> None:
         api_router = self.get_router("next")
-        add_next_api_available_channels(api_router=api_router, fields=fields)
+        add_next_available_channels(api_router=api_router, fields=fields)
 
     def add_lookup_api(self, field: str) -> None:
         api_router = self.get_router("lookup")
@@ -357,6 +359,10 @@ def add_lookup_api(self, field: str) -> None:
 
         add_lookup_routes(api_router=api_router, field=field, model=model)
 
+    def add_lookup_available_channels(self, fields: Optional[Set[str]] = None) -> None:
+        api_router = self.get_router("lookup")
+        add_lookup_available_channels(api_router=api_router, fields=fields)
+
     def add_send_api(self, field: str) -> None:
         api_router = self.get_router("send")
         dict_basket = self._is_dict_basket_field(field=field)
@@ -370,9 +376,9 @@ def add_send_api(self, field: str) -> None:
 
         add_send_routes(api_router=api_router, field=field, model=model, subroute_key=subroute_key)
 
-    def add_send_api_available_channels(self, fields: Optional[Set[str]] = None) -> None:
+    def add_send_available_channels(self, fields: Optional[Set[str]] = None) -> None:
         api_router = self.get_router("send")
-        add_send_api_available_channels(api_router=api_router, fields=fields)
+        add_send_available_channels(api_router=api_router, fields=fields)
 
     def add_state_api(self, field: str) -> None:
         api_router = self.get_router("state")
@@ -391,18 +397,19 @@ def add_state_api(self, field: str) -> None:
 
         add_state_routes(api_router=api_router, field=field, model=model, subroute_key=subroute_key)
 
-    def add_state_api_available_channels(self, fields: Optional[Set[str]] = None) -> None:
+    def add_state_available_channels(self, fields: Optional[Set[str]] = None) -> None:
         api_router = self.get_router("state")
-        add_state_api_available_channels(api_router=api_router, fields=fields)
+        add_state_available_channels(api_router=api_router, fields=fields)
 
-    def add_controls_api(self) -> None:
+    def add_controls_api(self, field: str) -> None:
         api_router = self.get_router("controls")
-        add_controls_routes(api_router)
+        add_controls_routes(api_router, field=field)
 
-    def _finalize(self) -> None:
-        # Add control APIs
-        self.add_controls_api()
+    def add_controls_available_channels(self, fields: Optional[Set[str]] = None) -> None:
+        api_router = self.get_router("controls")
+        add_controls_available_channels(api_router=api_router, fields=fields)
 
+    def _finalize(self) -> None:
         # Mount API routes
         self.add_api()
 

csp_gateway/server/web/routes/__init__.py

@@ -1,7 +1,7 @@
-from .controls import add_controls_routes
-from .last import add_last_api_available_channels, add_last_routes
-from .lookup import add_lookup_routes
-from .next import add_next_api_available_channels, add_next_routes
-from .send import add_send_api_available_channels, add_send_routes
-from .shared import prepare_response
-from .state import add_state_api_available_channels, add_state_routes
+from .controls import *
+from .last import *
+from .lookup import *
+from .next import *
+from .send import *
+from .shared import *
+from .state import *