feat!: Add url to api,stomp and greylog (#1056)

closes #985

Author: ZohebShaikh

helm/blueapi/values.yaml

@@ -95,8 +95,7 @@ tracing:
 # Config for the worker goes here, will be mounted into a config file
 worker:
   api:
-    host: 0.0.0.0 # Allow non-loopback traffic
-    port: 8000
+    url: http://0.0.0.0:8000/ # Allow non-loopback traffic
   env:
     sources:
       - kind: deviceFunctions
@@ -112,8 +111,7 @@ worker:
     auth:
       username: guest
       password: guest
-    host: rabbitmq
-    port: 61613
+    url: http://rabbitmq:61613/
   scratch:
     root: /blueapi-plugins/scratch
     repositories: []
@@ -123,8 +121,7 @@ worker:
     level: "INFO"
     graylog:
       enabled: False
-      host: "graylog-log-target.diamond.ac.uk"
-      port: 12232
+      url: http://graylog-log-target.diamond.ac.uk:12232/
 initContainer:
   enabled: false
 

src/blueapi/cli/cli.py

@@ -186,11 +186,13 @@ def listen_to_events(obj: dict) -> None:
     config: ApplicationConfig = obj["config"]
     if not config.stomp.enabled:
         raise BlueskyStreamingError("Message bus needs to be configured")
+    assert config.stomp.url.host is not None, "Stomp URL missing host"
+    assert config.stomp.url.port is not None, "Stomp URL missing port"
     event_bus_client = EventBusClient(
         StompClient.for_broker(
             broker=Broker(
-                host=config.stomp.host,
-                port=config.stomp.port,
+                host=config.stomp.url.host,
+                port=config.stomp.url.port,
                 auth=config.stomp.auth,
             )
         )
@@ -205,7 +207,7 @@ def on_event(
 
     print(
         "Subscribing to all bluesky events from "
-        f"{config.stomp.host}:{config.stomp.port}",
+        f"{config.stomp.url.host}:{config.stomp.url.port}",
         file=sys.stderr,
     )
     with event_bus_client:

src/blueapi/client/client.py

@@ -56,10 +56,12 @@ def from_config(cls, config: ApplicationConfig) -> "BlueapiClient":
             ...  # Swallow exceptions
         rest = BlueapiRestClient(config.api, session_manager=session_manager)
         if config.stomp.enabled:
+            assert config.stomp.url.host is not None, "Stomp URL missing host"
+            assert config.stomp.url.port is not None, "Stomp URL missing port"
             client = StompClient.for_broker(
                 broker=Broker(
-                    host=config.stomp.host,
-                    port=config.stomp.port,
+                    host=config.stomp.url.host,
+                    port=config.stomp.url.port,
                     auth=config.stomp.auth,
                 )
             )

src/blueapi/client/rest.py

@@ -248,7 +248,7 @@ def _request_and_deserialize(
         get_exception: Callable[[requests.Response], Exception | None] = _exception,
         params: Mapping[str, Any] | None = None,
     ) -> T:
-        url = self._url(suffix)
+        url = self._config.url.unicode_string().removesuffix("/") + suffix
         # Get the trace context to propagate to the REST API
         carr = get_context_propagator()
         response = requests.request(
@@ -266,7 +266,3 @@ def _request_and_deserialize(
             raise NoContent(target_type)
         deserialized = TypeAdapter(target_type).validate_python(response.json())
         return deserialized
-
-    def _url(self, suffix: str) -> str:
-        base_url = f"{self._config.protocol}://{self._config.host}:{self._config.port}"
-        return f"{base_url}{suffix}"

src/blueapi/config.py

@@ -11,6 +11,7 @@
 from pydantic import (
     BaseModel,
     Field,
+    HttpUrl,
     TypeAdapter,
     ValidationError,
     field_validator,
@@ -44,8 +45,7 @@ class StompConfig(BlueapiBaseModel):
         "event publishing",
         default=False,
     )
-    host: str = Field(description="STOMP broker host", default="localhost")
-    port: int = Field(description="STOMP broker port", default=61613)
+    url: HttpUrl = HttpUrl("http://localhost:61613")
     auth: BasicAuthentication | None = Field(
         description="Auth information for communicating with STOMP broker, if required",
         default=None,
@@ -84,8 +84,7 @@ class EnvironmentConfig(BlueapiBaseModel):
 
 class GraylogConfig(BlueapiBaseModel):
     enabled: bool = False
-    host: str = "localhost"
-    port: int = 5555
+    url: HttpUrl = HttpUrl("http://localhost:5555")
 
 
 class LoggingConfig(BlueapiBaseModel):
@@ -101,9 +100,7 @@ class CORSConfig(BlueapiBaseModel):
 
 
 class RestConfig(BlueapiBaseModel):
-    host: str = "localhost"
-    port: int = 8000
-    protocol: str = "http"
+    url: HttpUrl = HttpUrl("http://localhost:8000")
     cors: CORSConfig | None = None
 
 

src/blueapi/log.py

@@ -73,8 +73,11 @@ def set_up_graylog_handler(
         logger: Logger to attach handler to
         logging_config: LoggingConfig
     """
+    assert logging_config.graylog.url.host is not None, "Graylog URL missing host"
+    assert logging_config.graylog.url.port is not None, "Graylog URL missing port"
     graylog_handler = GELFTCPHandler(
-        logging_config.graylog.host, logging_config.graylog.port
+        logging_config.graylog.url.host,
+        logging_config.graylog.url.port,
     )
     graylog_handler.setLevel(logging_config.level)
 

src/blueapi/service/interface.py

@@ -69,11 +69,13 @@ def worker() -> TaskWorker:
 def stomp_client() -> StompClient | None:
     stomp_config: StompConfig = config().stomp
     if stomp_config.enabled:
+        assert stomp_config.url.host is not None, "Stomp URL missing host"
+        assert stomp_config.url.port is not None, "Stomp URL missing port"
         client = StompClient.for_broker(
             broker=Broker(
-                host=stomp_config.host,
-                port=stomp_config.port,
-                auth=stomp_config.auth,  # type: ignore
+                host=stomp_config.url.host,
+                port=stomp_config.url.port,
+                auth=stomp_config.auth,
             )
         )
 

src/blueapi/service/main.py

@@ -509,8 +509,9 @@ def start(config: ApplicationConfig):
         http_capture_headers_server_response=[",*"],
     )
     app.state.config = config
-
-    uvicorn.run(app, host=config.api.host, port=config.api.port)
+    assert config.api.url.host is not None, "API URL missing host"
+    assert config.api.url.port is not None, "API URL missing port"
+    uvicorn.run(app, host=config.api.url.host, port=config.api.url.port)
 
 
 async def add_api_version_header(

tests/unit_tests/example_yaml/rest_and_stomp_config.yaml

@@ -1,7 +1,5 @@
 api:
-  host: a.fake.host
-  port: 12345
+  url: http://a.fake.host:12345
 stomp:
   enabled: true
-  host: localhost
-  port: 61613
+  url: https://localhost:61613

tests/unit_tests/example_yaml/rest_config.yaml

@@ -1,3 +1,2 @@
 api:
-  host: a.fake.host
-  port: 12345
+  url: http://a.fake.host:12345