feat: Initial support for /version query

Author: Alan Christie

.github/workflows/tag.yaml

@@ -42,6 +42,8 @@ jobs:
       run: echo "owner=${OWNER,,}" >> "$GITHUB_ENV"
       env:
         OWNER: '${{ github.repository_owner }}'
+    - name: Set version
+      run: echo ${{ github.ref_name }} > VERSION
     - name: Build and Push (Tag)
       uses: docker/build-push-action@v6
       with:

.pre-commit-config.yaml

@@ -30,6 +30,7 @@ repos:
   - id: check-shebang-scripts-are-executable
   - id: detect-private-key
   - id: end-of-file-fixer
+    exclude: 'VERSION'
   - id: trailing-whitespace
     args:
     - --markdown-linebreak-ext=md

Dockerfile

@@ -51,8 +51,9 @@ ENV PATH=/.venv/bin:$PATH
 COPY app/ ./app/
 COPY logging.config .
 COPY docker-entrypoint.sh .
-COPY internal.env ./
-COPY public.env ./
+COPY internal.env .
+COPY public.env .
+COPY VERSION .
 
 # Probes...
 COPY probes/*.sh .

VERSION

@@ -0,0 +1 @@
+0.0.0

app/app.py

@@ -41,6 +41,9 @@
 # SQLite database path
 _DATABASE_PATH = "/data/event-streams.db"
 
+with open("VERSION", "r", encoding="utf-8") as version_file:
+    _VERSION: str = version_file.read().strip()
+
 
 def _get_location(uuid: str) -> str:
     """Returns the location (URL) for the event stream with the given UUID."""
@@ -95,6 +98,18 @@ class EventStreamPostRequestBody(BaseModel):
     routing_key: str
 
 
+class EventStreamGetVersionResponse(BaseModel):
+    """/event-stream/version/ GET response."""
+
+    # Category of the service (enumeration).
+    # We're a 'WEBSOCKET'
+    category: str
+    # Our name (ours is 'Python FastAPI')
+    name: str
+    # Our version number
+    version: str
+
+
 class EventStreamPostResponse(BaseModel):
     """/event-stream/ POST response."""
 
@@ -214,7 +229,18 @@ async def _get_from_queue(routing_key: str):
 # Endpoints for the 'internal' event-stream management API -----------------------------
 
 
-@app_internal.post("/event-stream/", status_code=status.HTTP_201_CREATED)
+@app_internal.post("/event-stream/version/", status_code=status.HTTP_200_CREATED)
+def get_es_version() -> EventStreamGetVersionResponse:
+    """Returns our version information."""
+    # And construct the location we'll be listening on...
+    return EventStreamPostResponse(
+        category="WEBSOCKET",
+        name="Python FastAPI",
+        version=_VERSION,
+    )
+
+
+@app_internal.post("/event-stream/", status_code=status.HTTP_201_OK)
 def post_es(request_body: EventStreamPostRequestBody) -> EventStreamPostResponse:
     """Create a new event-stream returning the endpoint location.