goosebit 0.2.4__py3-none-any.whl → 0.2.5__py3-none-any.whl

goosebit/__init__.py

@@ -4,16 +4,19 @@ from logging import getLogger
 from typing import Annotated
 
 from fastapi import Depends, FastAPI, HTTPException
+from fastapi.exception_handlers import http_exception_handler
 from fastapi.openapi.docs import get_swagger_ui_html
 from fastapi.requests import Request
 from fastapi.responses import RedirectResponse
 from fastapi.security import OAuth2PasswordRequestForm
 from opentelemetry.instrumentation.fastapi import FastAPIInstrumentor as Instrumentor
+from starlette.exceptions import HTTPException as StarletteHTTPException
 from tortoise.exceptions import ValidationError
 
 from goosebit import api, db, realtime, ui, updater
 from goosebit.api.telemetry import metrics
 from goosebit.auth import get_user_from_request, login_user, redirect_if_authenticated
+from goosebit.settings import config
 from goosebit.ui.nav import nav
 from goosebit.ui.static import static
 from goosebit.ui.templates import templates
@@ -65,6 +68,13 @@ async def tortoise_validation_exception_handler(request: Request, exc: Validatio
     raise HTTPException(422, str(exc))
 
 
+# Extend default handler to do logging
+@app.exception_handler(StarletteHTTPException)
+async def custom_http_exception_handler(request, exc):
+    logger.warning(f"HTTPException, request={request.url}, status={exc.status_code}, detail={exc.detail}")
+    return await http_exception_handler(request, exc)
+
+
 @app.middleware("http")
 async def attach_user(request: Request, call_next):
     request.scope["user"] = await get_user_from_request(request)
@@ -77,6 +87,12 @@ async def attach_nav(request: Request, call_next):
     return await call_next(request)
 
 
+@app.middleware("http")
+async def attach_config(request: Request, call_next):
+    request.scope["config"] = config
+    return await call_next(request)
+
+
 @app.get("/", include_in_schema=False)
 def root_redirect(request: Request):
     return RedirectResponse(request.url_for("ui_root"))

goosebit/api/v1/devices/device/routes.py

@@ -12,7 +12,7 @@ router = APIRouter(prefix="/{dev_id}")
 
 @router.get(
     "",
-    dependencies=[Security(validate_user_permissions, scopes=["home.read"])],
+    dependencies=[Security(validate_user_permissions, scopes=["device.read"])],
 )
 async def device_get(_: Request, updater: UpdateManager = Depends(get_update_manager)) -> DeviceResponse:
     device = await updater.get_device()
@@ -24,7 +24,7 @@ async def device_get(_: Request, updater: UpdateManager = Depends(get_update_man
 
 @router.get(
     "/log",
-    dependencies=[Security(validate_user_permissions, scopes=["home.read"])],
+    dependencies=[Security(validate_user_permissions, scopes=["device.read"])],
 )
 async def device_logs(_: Request, updater: UpdateManager = Depends(get_update_manager)) -> DeviceLogResponse:
     device = await updater.get_device()

goosebit/api/v1/devices/routes.py

@@ -1,12 +1,16 @@
 from __future__ import annotations
 
+import asyncio
+
 from fastapi import APIRouter, Security
 from fastapi.requests import Request
 
 from goosebit.api.responses import StatusResponse
 from goosebit.auth import validate_user_permissions
 from goosebit.db.models import Device
-from goosebit.updater.manager import delete_devices
+from goosebit.schema.devices import DeviceSchema
+from goosebit.schema.software import SoftwareSchema
+from goosebit.updater.manager import delete_devices, get_update_manager
 
 from . import device
 from .requests import DevicesDeleteRequest
@@ -17,11 +21,22 @@ router = APIRouter(prefix="/devices", tags=["devices"])
 
 @router.get(
     "",
-    dependencies=[Security(validate_user_permissions, scopes=["home.read"])],
+    dependencies=[Security(validate_user_permissions, scopes=["device.read"])],
 )
 async def devices_get(_: Request) -> DevicesResponse:
-    devices = await Device.all().prefetch_related("assigned_software", "hardware")
-    return DevicesResponse(devices=devices)
+    devices = await Device.all().prefetch_related("hardware", "assigned_software", "assigned_software__compatibility")
+    response = DevicesResponse(devices=devices)
+
+    async def set_assigned_sw(d: DeviceSchema):
+        updater = await get_update_manager(d.uuid)
+        _, target = await updater.get_update()
+        if target is not None:
+            await target.fetch_related("compatibility")
+            d.assigned_software = SoftwareSchema.model_validate(target)
+        return d
+
+    response.devices = await asyncio.gather(*[set_assigned_sw(d) for d in response.devices])
+    return response
 
 
 @router.delete(

goosebit/auth/__init__.py

@@ -16,7 +16,11 @@ from goosebit.settings.schema import User
 logger = logging.getLogger(__name__)
 
 
-oauth2_auth = OAuth2PasswordBearer(tokenUrl="login", auto_error=False)
+oauth2_bearer = OAuth2PasswordBearer(tokenUrl="login", auto_error=False)
+
+
+async def oauth2_auth(connection: HTTPConnection):
+    return await oauth2_bearer(connection)
 
 
 async def session_auth(connection: HTTPConnection) -> str:

goosebit/db/migrations/models/1_20241109151811_update.py

@@ -0,0 +1,11 @@
+from tortoise import BaseDBAsyncClient
+
+
+async def upgrade(db: BaseDBAsyncClient) -> str:
+    return """
+        ALTER TABLE "device" DROP COLUMN "log_complete";"""
+
+
+async def downgrade(db: BaseDBAsyncClient) -> str:
+    return """
+        ALTER TABLE "device" ADD "log_complete" INT NOT NULL  DEFAULT 0;"""

goosebit/db/models.py

@@ -7,6 +7,7 @@ from urllib.request import url2pathname
 
 import semver
 from anyio import Path
+from semver import Version
 from tortoise import Model, fields
 from tortoise.exceptions import ValidationError
 
@@ -68,7 +69,6 @@ class Device(Model):
     update_mode = fields.IntEnumField(UpdateModeEnum, default=UpdateModeEnum.ROLLOUT)
     last_state = fields.IntEnumField(UpdateStateEnum, default=UpdateStateEnum.UNKNOWN)
     progress = fields.IntField(null=True)
-    log_complete = fields.BooleanField(default=False)
     last_log = fields.TextField(null=True)
     last_seen = fields.BigIntField(null=True)
     last_ip = fields.CharField(max_length=15, null=True)
@@ -138,7 +138,7 @@ class Software(Model):
             return None
         return sorted(
             updates,
-            key=lambda x: semver.Version.parse(x.version),
+            key=lambda x: semver.Version.parse(x.version, optional_minor_and_patch=True),
             reverse=True,
         )[0]
 
@@ -156,3 +156,7 @@ class Software(Model):
             return self.path.name
         else:
             return self.uri
+
+    @property
+    def parsed_version(self) -> Version:
+        return semver.Version.parse(self.version, optional_minor_and_patch=True)

goosebit/realtime/logs.py

@@ -19,7 +19,7 @@ class RealtimeLogModel(BaseModel):
 
 @router.websocket(
     "/{dev_id}",
-    dependencies=[Security(validate_user_permissions, scopes=["home.read"])],
+    dependencies=[Security(validate_user_permissions, scopes=["device.read"])],
 )
 async def device_logs(websocket: WebSocket, dev_id: str):
     await websocket.accept()

goosebit/schema/devices.py

@@ -49,7 +49,7 @@ class DeviceSchema(BaseModel):
     @computed_field  # type: ignore[misc]
     @property
     def online(self) -> bool | None:
-        return self.last_seen < self.poll_seconds if self.last_seen is not None else None
+        return self.last_seen < (self.poll_seconds + 10) if self.last_seen is not None else None
 
     @computed_field  # type: ignore[misc]
     @property

goosebit/settings/schema.py

@@ -52,6 +52,8 @@ class GooseBitSettings(BaseSettings):
 
     logging: dict = LOGGING_DEFAULT
 
+    track_device_ip: bool = True
+
     @classmethod
     def settings_customise_sources(
         cls,

goosebit/ui/bff/common/requests.py

@@ -10,14 +10,6 @@ class DataTableSearchSchema(BaseModel):
     regex: bool | None = False
 
 
-class DataTableColumnSchema(BaseModel):
-    data: str | None
-    name: str | None = None
-    searchable: bool | None = None
-    orderable: bool | None = None
-    search: DataTableSearchSchema = DataTableSearchSchema()
-
-
 class DataTableOrderDirection(StrEnum):
     ASCENDING = "asc"
     DESCENDING = "desc"
@@ -36,21 +28,17 @@ class DataTableOrderSchema(BaseModel):
 
 class DataTableRequest(BaseModel):
     draw: int = 1
-    columns: list[DataTableColumnSchema] = list()
     order: list[DataTableOrderSchema] = list()
     start: int = 0
-    length: int = 0
+    length: int | None = None
     search: DataTableSearchSchema = DataTableSearchSchema()
 
     @computed_field  # type: ignore[misc]
     @property
     def order_query(self) -> str | None:
         try:
-            column = self.order[0].column
-            if column is None:
-                return None
-            if self.columns[column].name is None:
+            if len(self.order) == 0 or self.order[0].direction is None or self.order[0].name is None:
                 return None
-            return f"{self.order[0].direction}{self.columns[column].data}"
+            return f"{self.order[0].direction}{self.order[0].name}"
         except LookupError:
             return None

goosebit/ui/bff/common/responses.py

@@ -0,0 +1,16 @@
+from __future__ import annotations
+
+from pydantic import BaseModel
+
+
+class DTColumnDescription(BaseModel):
+    title: str
+    data: str
+    name: str | None = None
+
+    searchable: bool | None = None
+    orderable: bool | None = None
+
+
+class DTColumns(BaseModel):
+    columns: list[DTColumnDescription]

goosebit/ui/bff/devices/responses.py

@@ -21,11 +21,15 @@ class BFFDeviceResponse(BaseModel):
         if dt_query.search.value:
             query = query.filter(search_filter(dt_query.search.value))
 
+        filtered_records = await query.count()
+
         if dt_query.order_query:
             query = query.order_by(dt_query.order_query)
 
-        filtered_records = await query.count()
-        devices = await query.offset(dt_query.start).limit(dt_query.length).all()
+        if dt_query.length is not None:
+            query = query.limit(dt_query.length)
+
+        devices = await query.offset(dt_query.start).all()
         data = [DeviceSchema.model_validate(d) for d in devices]
 
         return cls(data=data, draw=dt_query.draw, records_total=total_records, records_filtered=filtered_records)

goosebit/ui/bff/devices/routes.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import asyncio
 from typing import Annotated
 
 from fastapi import APIRouter, Depends, Security
@@ -10,10 +11,14 @@ from goosebit.api.responses import StatusResponse
 from goosebit.api.v1.devices import routes
 from goosebit.auth import validate_user_permissions
 from goosebit.db.models import Device, Software, UpdateModeEnum, UpdateStateEnum
+from goosebit.schema.devices import DeviceSchema
+from goosebit.schema.software import SoftwareSchema
+from goosebit.settings import config
 from goosebit.ui.bff.common.requests import DataTableRequest
 from goosebit.ui.bff.common.util import parse_datatables_query
 from goosebit.updater.manager import get_update_manager
 
+from ..common.responses import DTColumnDescription, DTColumns
 from .requests import DevicesPatchRequest
 from .responses import BFFDeviceResponse
 
@@ -22,7 +27,7 @@ router = APIRouter(prefix="/devices")
 
 @router.get(
     "",
-    dependencies=[Security(validate_user_permissions, scopes=["home.read"])],
+    dependencies=[Security(validate_user_permissions, scopes=["device.read"])],
 )
 async def devices_get(dt_query: Annotated[DataTableRequest, Depends(parse_datatables_query)]) -> BFFDeviceResponse:
     def search_filter(search_value: str):
@@ -37,7 +42,18 @@ async def devices_get(dt_query: Annotated[DataTableRequest, Depends(parse_datata
 
     query = Device.all().prefetch_related("assigned_software", "hardware", "assigned_software__compatibility")
 
-    return await BFFDeviceResponse.convert(dt_query, query, search_filter)
+    response = await BFFDeviceResponse.convert(dt_query, query, search_filter)
+
+    async def set_assigned_sw(d: DeviceSchema):
+        updater = await get_update_manager(d.uuid)
+        _, target = await updater.get_update()
+        if target is not None:
+            await target.fetch_related("compatibility")
+            d.assigned_software = SoftwareSchema.model_validate(target)
+        return d
+
+    response.data = await asyncio.gather(*[set_assigned_sw(d) for d in response.data])
+    return response
 
 
 @router.patch(
@@ -73,3 +89,38 @@ router.add_api_route(
     dependencies=[Security(validate_user_permissions, scopes=["device.delete"])],
     name="bff_devices_delete",
 )
+
+
+@router.get(
+    "/columns",
+    dependencies=[Security(validate_user_permissions, scopes=["device.read"])],
+    response_model_exclude_none=True,
+)
+async def devices_get_columns() -> DTColumns:
+    columns = []
+    columns.append(DTColumnDescription(title="Online", data="online"))
+    columns.append(DTColumnDescription(title="UUID", data="uuid", name="uuid", searchable=True, orderable=True))
+    columns.append(DTColumnDescription(title="Name", data="name", name="name", searchable=True, orderable=True))
+    columns.append(DTColumnDescription(title="Model", data="hw_model"))
+    columns.append(DTColumnDescription(title="Revision", data="hw_revision"))
+    columns.append(DTColumnDescription(title="Feed", data="feed", name="feed", searchable=True, orderable=True))
+    columns.append(
+        DTColumnDescription(
+            title="Installed Software", data="sw_version", name="sw_version", searchable=True, orderable=True
+        )
+    )
+    columns.append(DTColumnDescription(title="Target Software", data="sw_target_version"))
+    columns.append(
+        DTColumnDescription(
+            title="Update Mode", data="update_mode", name="update_mode", searchable=True, orderable=True
+        )
+    )
+    columns.append(
+        DTColumnDescription(title="State", data="last_state", name="last_state", searchable=True, orderable=True)
+    )
+    columns.append(DTColumnDescription(title="Force Update", data="force_update"))
+    columns.append(DTColumnDescription(title="Progress", data="progress"))
+    if config.track_device_ip:
+        columns.append(DTColumnDescription(title="Last IP", data="last_ip"))
+    columns.append(DTColumnDescription(title="Last Seen", data="last_seen"))
+    return DTColumns(columns=columns)

goosebit/ui/bff/rollouts/responses.py

@@ -19,11 +19,15 @@ class BFFRolloutsResponse(BaseModel):
         if dt_query.search.value:
             query = query.filter(search_filter(dt_query.search.value))
 
+        filtered_records = await query.count()
+
         if dt_query.order_query:
             query = query.order_by(dt_query.order_query)
 
-        filtered_records = await query.count()
-        rollouts = await query.offset(dt_query.start).limit(dt_query.length).all()
+        if dt_query.length is not None:
+            query = query.limit(dt_query.length)
+
+        rollouts = await query.offset(dt_query.start).all()
         data = [RolloutSchema.model_validate(r) for r in rollouts]
 
         return cls(data=data, draw=dt_query.draw, records_total=total_records, records_filtered=filtered_records)

goosebit/ui/bff/routes.py

@@ -1,10 +1,12 @@
 from __future__ import annotations
 
-from fastapi import APIRouter
+from fastapi import APIRouter, Depends
+
+from goosebit.auth import validate_current_user
 
 from . import devices, download, rollouts, software
 
-router = APIRouter(prefix="/bff", tags=["bff"])
+router = APIRouter(prefix="/bff", tags=["bff"], dependencies=[Depends(validate_current_user)])
 router.include_router(devices.router)
 router.include_router(software.router)
 router.include_router(rollouts.router)

goosebit/ui/bff/software/responses.py

@@ -5,7 +5,7 @@ from tortoise.expressions import Q
 from tortoise.queryset import QuerySet
 
 from goosebit.schema.software import SoftwareSchema
-from goosebit.ui.bff.common.requests import DataTableRequest
+from goosebit.ui.bff.common.requests import DataTableOrderDirection, DataTableRequest
 
 
 class BFFSoftwareResponse(BaseModel):
@@ -21,17 +21,27 @@ class BFFSoftwareResponse(BaseModel):
         if dt_query.search.value:
             query = query.filter(search_filter(dt_query.search.value))
 
-        if dt_query.order_query:
-            query = query.order_by(dt_query.order_query)
-
         filtered_records = await query.count()
 
-        query = query.offset(dt_query.start)
+        if len(dt_query.order) > 0 and dt_query.order[0].name == "version":
+            # ordering cannot be delegated to database as semantic versioning sorting is not supported
+            software = await query.all()
+            reverse = dt_query.order[0].dir == DataTableOrderDirection.DESCENDING
+            software.sort(key=lambda s: s.parsed_version, reverse=reverse)
+
+            # in-memory paging
+            if dt_query.length is None:
+                software = software[dt_query.start :]
+            else:
+                software = software[dt_query.start : dt_query.start + dt_query.length]
+
+        else:
+            # if no ordering is specified, database-side paging can be used
+            if dt_query.length is not None:
+                query = query.limit(dt_query.length)
 
-        if not dt_query.length == 0:
-            query = query.limit(dt_query.length)
+            software = await query.offset(dt_query.start).all()
 
-        devices = await query.all()
-        data = [SoftwareSchema.model_validate(d) for d in devices]
+        data = [SoftwareSchema.model_validate(s) for s in software]
 
         return cls(data=data, draw=dt_query.draw, records_total=total_records, records_filtered=filtered_records)

goosebit/ui/routes.py

@@ -11,27 +11,18 @@ from .templates import templates
 
 oauth2_scheme = OAuth2PasswordBearer(tokenUrl="login")
 
-router = APIRouter(prefix="/ui", dependencies=[Depends(redirect_if_unauthenticated)], include_in_schema=False)
+router = APIRouter(prefix="/ui", include_in_schema=False)
 router.include_router(bff.router)
 
 
-@router.get("")
+@router.get("", dependencies=[Depends(redirect_if_unauthenticated)])
 async def ui_root(request: Request):
-    return RedirectResponse(request.url_for("home_ui"))
-
-
-@router.get(
-    "/home",
-    dependencies=[Security(validate_user_permissions, scopes=["home.read"])],
-)
-@nav.route("Home", permissions="home.read")
-async def home_ui(request: Request):
-    return templates.TemplateResponse(request, "index.html.jinja", context={"title": "Home"})
+    return RedirectResponse(request.url_for("devices_ui"))
 
 
 @router.get(
     "/devices",
-    dependencies=[Security(validate_user_permissions, scopes=["device.read"])],
+    dependencies=[Depends(redirect_if_unauthenticated), Security(validate_user_permissions, scopes=["device.read"])],
 )
 @nav.route("Devices", permissions="device.read")
 async def devices_ui(request: Request):
@@ -40,7 +31,7 @@ async def devices_ui(request: Request):
 
 @router.get(
     "/software",
-    dependencies=[Security(validate_user_permissions, scopes=["software.read"])],
+    dependencies=[Depends(redirect_if_unauthenticated), Security(validate_user_permissions, scopes=["software.read"])],
 )
 @nav.route("Software", permissions="software.read")
 async def software_ui(request: Request):
@@ -49,7 +40,7 @@ async def software_ui(request: Request):
 
 @router.get(
     "/rollouts",
-    dependencies=[Security(validate_user_permissions, scopes=["rollout.read"])],
+    dependencies=[Depends(redirect_if_unauthenticated), Security(validate_user_permissions, scopes=["rollout.read"])],
 )
 @nav.route("Rollouts", permissions="rollout.read")
 async def rollouts_ui(request: Request):
@@ -58,7 +49,7 @@ async def rollouts_ui(request: Request):
 
 @router.get(
     "/logs/{dev_id}",
-    dependencies=[Security(validate_user_permissions, scopes=["device.read"])],
+    dependencies=[Depends(redirect_if_unauthenticated), Security(validate_user_permissions, scopes=["device.read"])],
 )
 async def logs_ui(request: Request, dev_id: str):
     return templates.TemplateResponse(request, "logs.html.jinja", context={"title": "Log", "device": dev_id})

goosebit/ui/static/js/devices.js

@@ -1,29 +1,70 @@
 let dataTable;
 
+const renderFunctions = {
+    online: (data, type) => {
+        if (type === "display" || type === "filter") {
+            const color = data ? "success" : "danger";
+            return `
+            <div class="text-${color}">
+                ●
+            </div>
+            `;
+        }
+        return data;
+    },
+    force_update: (data, type) => {
+        if (type === "display" || type === "filter") {
+            const color = data ? "success" : "muted";
+            return `
+            <div class="text-${color}">
+                ●
+            </div>
+            `;
+        }
+        return data;
+    },
+    progress: (data, type) => {
+        if (type === "display" || type === "filter") {
+            return data ? `${data}%` : "-";
+        }
+        return data;
+    },
+    last_seen: (data, type) => {
+        if (type === "display" || type === "filter") {
+            return secondsToRecentDate(data);
+        }
+        return data;
+    },
+};
+
 document.addEventListener("DOMContentLoaded", async () => {
+    const columnConfig = await get_request("/ui/bff/devices/columns");
+    for (const col in columnConfig.columns) {
+        const colDesc = columnConfig.columns[col];
+        const colName = colDesc.data;
+        if (renderFunctions[colName]) {
+            columnConfig.columns[col].render = renderFunctions[colName];
+        }
+    }
+
     dataTable = new DataTable("#device-table", {
         responsive: true,
         paging: true,
         processing: false,
         serverSide: true,
-        order: [],
+        order: { name: "uuid", dir: "asc" },
         scrollCollapse: true,
         scroller: true,
         scrollY: "65vh",
         stateSave: true,
-        stateLoadParams: (settings, data) => {
-            // if save state is older than last breaking code change...
-            if (data.time <= 1722434189000) {
-                // ... delete it
-                for (const key of Object.keys(data)) {
-                    delete data[key];
-                }
-            }
-        },
         select: true,
         rowId: "uuid",
         ajax: {
-            url: "/ui/bff/devices/",
+            url: "/ui/bff/devices",
+            data: (data) => {
+                // biome-ignore lint/performance/noDelete: really has to be deleted
+                delete data.columns;
+            },
             contentType: "application/json",
         },
         initComplete: () => {
@@ -37,64 +78,7 @@ document.addEventListener("DOMContentLoaded", async () => {
                 render: (data) => data || "-",
             },
         ],
-        columns: [
-            {
-                data: "online",
-                render: (data, type) => {
-                    if (type === "display" || type === "filter") {
-                        const color = data ? "success" : "danger";
-                        return `
-                        <div class="text-${color}">
-                            ●
-                        </div>
-                        `;
-                    }
-                    return data;
-                },
-            },
-            { data: "uuid", searchable: true, orderable: true },
-            { data: "name", searchable: true, orderable: true },
-            { data: "hw_model" },
-            { data: "hw_revision" },
-            { data: "feed", searchable: true, orderable: true },
-            { data: "sw_version", searchable: true, orderable: true },
-            { data: "sw_target_version" },
-            { data: "update_mode", searchable: true, orderable: true },
-            { data: "last_state", searchable: true, orderable: true },
-            {
-                data: "force_update",
-                render: (data, type) => {
-                    if (type === "display" || type === "filter") {
-                        const color = data ? "success" : "muted";
-                        return `
-                        <div class="text-${color}">
-                            ●
-                        </div>
-                        `;
-                    }
-                    return data;
-                },
-            },
-            {
-                data: "progress",
-                render: (data, type) => {
-                    if (type === "display" || type === "filter") {
-                        return data ? `${data}%` : "-";
-                    }
-                    return data;
-                },
-            },
-            { data: "last_ip" },
-            {
-                data: "last_seen",
-                render: (data, type) => {
-                    if (type === "display" || type === "filter") {
-                        return secondsToRecentDate(data);
-                    }
-                    return data;
-                },
-            },
-        ],
+        columns: columnConfig.columns,
         layout: {
             top1Start: {
                 buttons: [