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

goosebit/ui/static/js/rollouts.js

@@ -6,24 +6,22 @@ document.addEventListener("DOMContentLoaded", async () => {
         paging: true,
         processing: true,
         serverSide: true,
-        order: [1, "desc"],
+        order: {
+            name: "created_at",
+            dir: "desc",
+        },
         scrollCollapse: true,
         scroller: true,
         scrollY: "65vh",
         stateSave: true,
-        stateLoadParams: (settings, data) => {
-            // if save state is older than last breaking code change...
-            if (data.time <= 1722413708000) {
-                // ... delete it
-                for (const key of Object.keys(data)) {
-                    delete data[key];
-                }
-            }
-        },
         select: true,
         rowId: "id",
         ajax: {
             url: "/ui/bff/rollouts",
+            data: (data) => {
+                // biome-ignore lint/performance/noDelete: really has to be deleted
+                delete data.columns;
+            },
             contentType: "application/json",
         },
         initComplete: () => {
@@ -38,9 +36,14 @@ document.addEventListener("DOMContentLoaded", async () => {
         ],
         columns: [
             { data: "id", visible: false },
-            { data: "created_at", orderable: true, render: (data) => new Date(data).toLocaleString() },
-            { data: "name", searchable: true, orderable: true },
-            { data: "feed", searchable: true, orderable: true },
+            {
+                data: "created_at",
+                name: "created_at",
+                orderable: true,
+                render: (data) => new Date(data).toLocaleString(),
+            },
+            { data: "name", name: "name", searchable: true, orderable: true },
+            { data: "feed", name: "feed", searchable: true, orderable: true },
             { data: "sw_file" },
             { data: "sw_version" },
             {

goosebit/ui/static/js/software.js

@@ -172,22 +172,16 @@ document.addEventListener("DOMContentLoaded", () => {
         paging: true,
         processing: false,
         serverSide: true,
-        order: [2, "desc"],
         scrollCollapse: true,
         scroller: true,
         scrollY: "60vh",
         stateSave: true,
-        stateLoadParams: (settings, data) => {
-            // if save state is older than last breaking code change...
-            if (data.time <= 1722415428000) {
-                // ... delete it
-                for (const key of Object.keys(data)) {
-                    delete data[key];
-                }
-            }
-        },
         ajax: {
             url: "/ui/bff/software",
+            data: (data) => {
+                // biome-ignore lint/performance/noDelete: really has to be deleted
+                delete data.columns;
+            },
             contentType: "application/json",
         },
         initComplete: () => {
@@ -204,7 +198,7 @@ document.addEventListener("DOMContentLoaded", () => {
         columns: [
             { data: "id", visible: false },
             { data: "name" },
-            { data: "version", searchable: true, orderable: true },
+            { data: "version", name: "version", searchable: true, orderable: true },
             {
                 data: "compatibility",
                 render: (data) => {

goosebit/ui/static/js/util.js

@@ -22,7 +22,7 @@ function secondsToRecentDate(t) {
 
 async function updateSoftwareSelection(devices = null) {
     try {
-        const url = new URL("/ui/bff/software", window.location.origin);
+        const url = new URL("/ui/bff/software?order[0][dir]=desc&order[0][name]=version", window.location.origin);
         if (devices != null) {
             for (const device of devices) {
                 url.searchParams.append("uuids", device.uuid);
@@ -64,6 +64,26 @@ async function updateSoftwareSelection(devices = null) {
     }
 }
 
+async function get_request(url) {
+    const response = await fetch(url, {
+        method: "GET",
+    });
+
+    const result = await response.json();
+    if (!response.ok) {
+        if (result.detail) {
+            Swal.fire({
+                title: "Warning",
+                text: result.detail,
+                icon: "warning",
+                confirmButtonText: "Understood",
+            });
+        }
+
+        throw new Error(`POST ${url} failed for ${JSON.stringify(object)}`);
+    }
+    return result;
+}
 async function post_request(url, object) {
     const response = await fetch(url, {
         method: "POST",

goosebit/ui/templates/devices.html.jinja

@@ -4,26 +4,6 @@
         <div class="row p-2 d-flex justify-content-center">
             <div class="col">
                 <table id="device-table" class="table table-hover">
-                    <thead>
-                        <tr>
-                            <th>Up</th>
-                            <th>UUID</th>
-                            <th>Name</th>
-                            <th>Model</th>
-                            <th>Revision</th>
-                            <th>Feed</th>
-                            <th>Installed Software</th>
-                            <th>Target Software</th>
-                            <th>Update Mode</th>
-                            <th>State</th>
-                            <th>Force Update</th>
-                            <th>Progress</th>
-                            <th>Last IP</th>
-                            <th>Last Seen</th>
-                        </tr>
-                    </thead>
-                    <tbody id="devices-list">
-                    </tbody>
                 </table>
             </div>
         </div>

goosebit/ui/templates/nav.html.jinja

@@ -60,13 +60,24 @@
                 box-shadow: none!important;
             }
         </style>
-        <script>const TABLE_UPDATE_TIME = 3000;</script>
+        <script>
+            const TABLE_UPDATE_TIME = 3000;
+            DataTable.ext.errMode = function ( e, settings, helpPage, message ) {
+                if (e.jqXHR.status == 401) {
+                    window.location.reload();
+                } else if (e.jqXHR.status >= 200 && e.jqXHR.status < 300) {
+                    console.error("AJAX query error when reloading datatable");
+                }
+                console.error("Unknown error when reloading datatable");
+            };
+
+        </script>
         <script src="{{ url_for('static', path='js/util.js') }}"></script>
     </head>
     <body data-bs-theme="dark">
         <nav class="navbar navbar-expand-lg bg-body-tertiary">
             <div class="container-fluid">
-                <a class="navbar-brand" href="{{ request.url_for('home_ui') }}">
+                <a class="navbar-brand" href="{{ request.url_for('devices_ui') }}">
                     <img src="{{ request.url_for('static', path='svg/goosebit-logo.svg') }}"
                          class="me-2"
                          height="30px"

goosebit/updater/controller/v1/routes.py

@@ -2,7 +2,7 @@ import logging
 
 from fastapi import APIRouter, Depends, HTTPException
 from fastapi.requests import Request
-from fastapi.responses import FileResponse, RedirectResponse, Response
+from fastapi.responses import FileResponse, Response
 
 from goosebit.db.models import Software, UpdateStateEnum
 from goosebit.settings import config
@@ -25,7 +25,6 @@ router = APIRouter(prefix="/v1")
 async def polling(request: Request, dev_id: str, updater: UpdateManager = Depends(get_update_manager)):
     links: dict[str, dict[str, str]] = {}
 
-    sleep = updater.poll_time
     device = await updater.get_device()
 
     if device is None:
@@ -45,14 +44,15 @@ async def polling(request: Request, dev_id: str, updater: UpdateManager = Depend
         logger.info(f"Skip: registration required, device={updater.dev_id}")
 
     elif device.last_state == UpdateStateEnum.ERROR and not device.force_update:
-        logger.warning(f"Skip: device in error state, device={updater.dev_id}")
-        pass
+        sleep = config.poll_time_default
+        logger.info(f"Skip: device in error state, device={updater.dev_id}")
 
     else:
         # provide update if available. Note: this is also required while in state "running", otherwise swupdate
         # won't confirm a successful testing (might be a bug/problem in swupdate)
         handling_type, software = await updater.get_update()
         if handling_type != HandlingType.SKIP and software is not None:
+            sleep = config.poll_time_updating
             links["deploymentBase"] = {
                 "href": str(
                     request.url_for(
@@ -63,6 +63,11 @@ async def polling(request: Request, dev_id: str, updater: UpdateManager = Depend
                 )
             }
             logger.info(f"Forced: update available, device={updater.dev_id}")
+        else:
+            sleep = config.poll_time_default
+
+    # update poll time on manager so that UI can properly display if device is overdue
+    updater.poll_time = sleep
 
     return {
         "config": {"polling": {"sleep": sleep}},
@@ -102,54 +107,55 @@ async def deployment_feedback(
     _: Request, data: FeedbackSchema, action_id: int, updater: UpdateManager = Depends(get_update_manager)
 ):
     if data.status.execution == FeedbackStatusExecutionState.PROCEEDING:
-        await updater.update_device_state(UpdateStateEnum.RUNNING)
+        device = await updater.get_device()
+        if device and device.last_state != UpdateStateEnum.RUNNING:
+            await updater.clear_log()
+            await updater.update_device_state(UpdateStateEnum.RUNNING)
+
         logger.debug(f"Installation in progress, device={updater.dev_id}")
 
     elif data.status.execution == FeedbackStatusExecutionState.CLOSED:
         await updater.update_force_update(False)
-        await updater.update_log_complete(True)
 
         reported_software = await Software.get_or_none(id=action_id)
 
         # From hawkBit docu: DDI defines also a status NONE which will not be interpreted by the update server
         # and handled like SUCCESS.
         if data.status.result.finished in [FeedbackStatusResultFinished.SUCCESS, FeedbackStatusResultFinished.NONE]:
+            await updater.deployment_action_success()
             await updater.update_device_state(UpdateStateEnum.FINISHED)
 
-            # not guaranteed to be the correct rollout - see next comment.
             rollout = await updater.get_rollout()
             if rollout:
                 if rollout.software == reported_software:
                     rollout.success_count += 1
                     await rollout.save()
                 else:
+                    # edge case where device update mode got changed while update was running
                     logging.warning(
                         f"Updating rollout success stats failed, software={reported_software.id}, device={updater.dev_id}"  # noqa: E501
                     )
 
-            # setting the currently installed version based on the current assigned software / existing rollouts
-            # is problematic. Better to assign custom action_id for each update (rollout id? software id? new id?).
-            # Alternatively - but requires customization on the gateway side - use version reported by the gateway.
             await updater.update_sw_version(reported_software.version)
             logger.debug(f"Installation successful, software={reported_software.version}, device={updater.dev_id}")
 
         elif data.status.result.finished == FeedbackStatusResultFinished.FAILURE:
             await updater.update_device_state(UpdateStateEnum.ERROR)
 
-            # not guaranteed to be the correct rollout - see comment above.
             rollout = await updater.get_rollout()
             if rollout:
                 if rollout.software == reported_software:
                     rollout.failure_count += 1
                     await rollout.save()
                 else:
+                    # edge case where device update mode got changed while update was running
                     logging.warning(
                         f"Updating rollout failure stats failed, software={reported_software.id}, device={updater.dev_id}"  # noqa: E501
                     )
 
             logger.debug(f"Installation failed, software={reported_software.version}, device={updater.dev_id}")
     else:
-        logging.warning(
+        logging.error(
             f"Device reported unhandled execution state, state={data.status.execution}, device={updater.dev_id}"
         )
 
@@ -179,11 +185,11 @@ async def download_artifact(_: Request, updater: UpdateManager = Depends(get_upd
     _, software = await updater.get_update()
     if software is None:
         raise HTTPException(404)
-    if software.local:
-        return FileResponse(
-            software.path,
-            media_type="application/octet-stream",
-            filename=software.path.name,
-        )
-    else:
-        return RedirectResponse(url=software.uri)
+
+    assert software.local, "device requests local software to download"
+
+    return FileResponse(
+        software.path,
+        media_type="application/octet-stream",
+        filename=software.path.name,
+    )

goosebit/updater/manager.py

@@ -59,7 +59,7 @@ class UpdateManager(ABC):
     async def update_device_state(self, state: UpdateStateEnum) -> None:
         return
 
-    async def update_last_connection(self, last_seen: int, last_ip: str) -> None:
+    async def update_last_connection(self, last_seen: int, last_ip: str | None = None) -> None:
         return
 
     async def update_update(self, update_mode: UpdateModeEnum, software: Software | None):
@@ -74,7 +74,10 @@ class UpdateManager(ABC):
     async def update_config_data(self, **kwargs):
         return
 
-    async def update_log_complete(self, log_complete: bool):
+    async def deployment_action_success(self):
+        return
+
+    async def clear_log(self) -> None:
         return
 
     async def get_rollout(self) -> Rollout | None:
@@ -83,9 +86,11 @@ class UpdateManager(ABC):
     @asynccontextmanager
     async def subscribe_log(self, callback: Callable):
         device = await self.get_device()
+        # do not modify, breaks when combined
         subscribers = self.log_subscribers
         subscribers.append(callback)
         self.log_subscribers = subscribers
+
         if device is not None:
             await callback(device.last_log)
         try:
@@ -93,6 +98,7 @@ class UpdateManager(ABC):
         except asyncio.CancelledError:
             pass
         finally:
+            # do not modify, breaks when combined
             subscribers = self.log_subscribers
             subscribers.remove(callback)
             self.log_subscribers = subscribers
@@ -133,27 +139,6 @@ class UpdateManager(ABC):
     async def update_log(self, log_data: str) -> None: ...
 
 
-class UnknownUpdateManager(UpdateManager):
-    def __init__(self, dev_id: str):
-        super().__init__(dev_id)
-        self.poll_time = config.poll_time_updating
-
-    async def _get_software(self) -> Software | None:
-        device = await self.get_device()
-        if device is None:
-            return None
-        return await Software.latest(device)
-
-    async def get_update(self) -> tuple[HandlingType, Software | None]:
-        software = await self._get_software()
-        if software is None:
-            return HandlingType.SKIP, None
-        return HandlingType.FORCED, software
-
-    async def update_log(self, log_data: str) -> None:
-        return
-
-
 class DeviceUpdateManager(UpdateManager):
     hardware_default = None
 
@@ -193,10 +178,12 @@ class DeviceUpdateManager(UpdateManager):
         device.last_state = state
         await self.save_device(device, update_fields=["last_state"])
 
-    async def update_last_connection(self, last_seen: int, last_ip: str) -> None:
+    async def update_last_connection(self, last_seen: int, last_ip: str | None = None) -> None:
         device = await self.get_device()
         device.last_seen = last_seen
-        if ":" in last_ip:
+        if last_ip is None:
+            await self.save_device(device, update_fields=["last_seen"])
+        elif ":" in last_ip:
             device.last_ipv6 = last_ip
             await self.save_device(device, update_fields=["last_seen", "last_ipv6"])
         else:
@@ -243,10 +230,10 @@ class DeviceUpdateManager(UpdateManager):
         if modified:
             await self.save_device(device, update_fields=["hardware_id", "last_state", "sw_version"])
 
-    async def update_log_complete(self, log_complete: bool):
+    async def deployment_action_success(self):
         device = await self.get_device()
-        device.log_complete = log_complete
-        await self.save_device(device, update_fields=["log_complete"])
+        device.progress = 100
+        await self.save_device(device, update_fields=["progress"])
 
     async def get_rollout(self) -> Rollout | None:
         device = await self.get_device()
@@ -290,23 +277,15 @@ class DeviceUpdateManager(UpdateManager):
 
         if software is None:
             handling_type = HandlingType.SKIP
-            self.poll_time = config.poll_time_default
 
         elif software.version == device.sw_version and not device.force_update:
             handling_type = HandlingType.SKIP
-            self.poll_time = config.poll_time_default
 
         elif device.last_state == UpdateStateEnum.ERROR and not device.force_update:
             handling_type = HandlingType.SKIP
-            self.poll_time = config.poll_time_default
 
         else:
             handling_type = HandlingType.FORCED
-            self.poll_time = config.poll_time_updating
-
-            if device.log_complete:
-                await self.update_log_complete(False)
-                await self.clear_log()
 
         return handling_type, software
 
@@ -318,23 +297,15 @@ class DeviceUpdateManager(UpdateManager):
         if device.last_log is None:
             device.last_log = ""
 
+        # SWUpdate-specific log parsing to report progress
         matches = re.findall(r"Downloaded (\d+)%", log_data)
         if matches:
             device.progress = matches[-1]
 
-        if log_data.startswith("Installing Update Chunk Artifacts."):
-            # clear log
-            device.last_log = ""
-            await self.publish_log(None)
-
-        if not log_data == "Skipped Update.":
-            device.last_log += f"{log_data}\n"
-            await self.publish_log(f"{log_data}\n")
+        device.last_log += f"{log_data}\n"
+        await self.publish_log(f"{log_data}\n")
 
-        await self.save_device(
-            device,
-            update_fields=["progress", "last_log"],
-        )
+        await self.save_device(device, update_fields=["progress", "last_log"])
 
     async def clear_log(self) -> None:
         device = await self.get_device()
@@ -344,10 +315,7 @@ class DeviceUpdateManager(UpdateManager):
 
 
 async def get_update_manager(dev_id: str) -> UpdateManager:
-    if dev_id == "unknown":
-        return UnknownUpdateManager("unknown")
-    else:
-        return DeviceUpdateManager(dev_id)
+    return DeviceUpdateManager(dev_id)
 
 
 async def delete_devices(ids: list[str]):

goosebit/updater/routes.py

@@ -3,14 +3,18 @@ import time
 from fastapi import APIRouter, Depends
 from fastapi.requests import Request
 
+from goosebit.settings import config
+
 from . import controller
 from .manager import get_update_manager
 
 
 async def log_last_connection(request: Request, dev_id: str):
-    host = request.client.host
     updater = await get_update_manager(dev_id)
-    await updater.update_last_connection(round(time.time()), host)
+    if config.track_device_ip:
+        await updater.update_last_connection(round(time.time()), request.client.host)
+    else:
+        await updater.update_last_connection(round(time.time()))
 
 
 router = APIRouter(

goosebit/updates/swdesc.py

@@ -23,7 +23,7 @@ def _append_compatibility(boardname, value, compatibility):
 def parse_descriptor(swdesc: libconf.AttrDict[Any, Any | None]):
     swdesc_attrs = {}
     try:
-        swdesc_attrs["version"] = semver.Version.parse(swdesc["software"]["version"])
+        swdesc_attrs["version"] = semver.Version.parse(swdesc["software"]["version"], optional_minor_and_patch=True)
         compatibility: list[dict[str, str]] = []
         _append_compatibility("default", swdesc["software"], compatibility)
 

{goosebit-0.2.4.dist-info → goosebit-0.2.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: goosebit
-Version: 0.2.4
+Version: 0.2.5
 Summary: 
 Author: Upstream Data
 Author-email: brett@upstreamdata.ca
@@ -8,6 +8,7 @@ Requires-Python: >=3.11,<4.0
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Provides-Extra: postgresql
 Requires-Dist: aerich (>=0.7.2,<0.8.0)
 Requires-Dist: aiocache (>=0.12.2,<0.13.0)
@@ -19,9 +20,9 @@ Requires-Dist: itsdangerous (>=2.2.0,<3.0.0)
 Requires-Dist: jinja2 (>=3.1.4,<4.0.0)
 Requires-Dist: joserfc (>=1.0.0,<2.0.0)
 Requires-Dist: libconf (>=2.0.1,<3.0.0)
-Requires-Dist: opentelemetry-distro (>=0.47b0,<0.48)
-Requires-Dist: opentelemetry-exporter-prometheus (>=0.47b0,<0.48)
-Requires-Dist: opentelemetry-instrumentation-fastapi (>=0.47b0,<0.48)
+Requires-Dist: opentelemetry-distro (>=0.49b1,<0.50)
+Requires-Dist: opentelemetry-exporter-prometheus (>=0.49b1,<0.50)
+Requires-Dist: opentelemetry-instrumentation-fastapi (>=0.49b1,<0.50)
 Requires-Dist: pydantic-settings (>=2.4.0,<3.0.0)
 Requires-Dist: python-multipart (>=0.0.9,<0.0.10)
 Requires-Dist: semver (>=3.0.2,<4.0.0)
@@ -33,6 +34,8 @@ Description-Content-Type: text/markdown
 
 <img src="docs/img/goosebit-logo.png" style="width: 100px; height: 100px; display: block;">
 
+[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/UpstreamDataInc/goosebit/badge)](https://scorecard.dev/viewer/?uri=github.com/UpstreamDataInc/goosebit)
+
 ---
 
 A simplistic, opinionated remote update server implementing hawkBit™'s [DDI API](https://eclipse.dev/hawkbit/apis/ddi_api/).
@@ -50,7 +53,6 @@ A simplistic, opinionated remote update server implementing hawkBit™'s [DDI AP
 2. Create the database:
 
     ```bash
-    poetry run aerich init -t goosebit.db.config
     poetry run aerich upgrade
     ```
 
@@ -125,6 +127,12 @@ After a model change create the migration
 poetry run aerich migrate
 ```
 
+To seed some sample data (attention: drops all current data) use
+
+```bash
+poetry run generate-sample-data
+```
+
 ### Code formatting and linting
 
 Code is formatted using different tools
@@ -147,7 +155,7 @@ poetry run pre-commit install
 To manually apply the hooks to all files use:
 
 ```bash
-pre-commit run --all-files
+poetry run pre-commit run --all-files
 ```
 
 ### Testing