bug: fix plugin custom permissions

Plugin permissions wouldn't have the correct value when being shown in settings.  This fixes that issue by using a list of permissions rather than a single top level permission.

Author: b-rowan

goosebit/__init__.py

@@ -14,8 +14,12 @@
 from tortoise.exceptions import ValidationError
 
 from goosebit import api, db, plugins, ui, updater
-from goosebit.auth import get_user_from_request, login_user, redirect_if_authenticated
-from goosebit.auth.permissions import GOOSEBIT_PERMISSIONS
+from goosebit.auth import (
+    get_user_from_request,
+    login_user,
+    permissions,
+    redirect_if_authenticated,
+)
 from goosebit.device_manager import DeviceManager
 from goosebit.settings import PWD_CXT, config  # type: ignore[attr-defined]
 from goosebit.ui.nav import nav
@@ -84,8 +88,8 @@ async def lifespan(_: FastAPI) -> AsyncGenerator[None, None]:
         DeviceManager.add_update_source(plugin.update_source_hook)
     if plugin.config_data_hook is not None:
         DeviceManager.add_config_callback(plugin.config_data_hook)
-    if plugin.permissions is not None and GOOSEBIT_PERMISSIONS.sub_permissions is not None:
-        GOOSEBIT_PERMISSIONS.sub_permissions.append(plugin.permissions)
+    if plugin.permissions is not None:
+        permissions.HANDLER.append(plugin.permissions)
 
 
 # Custom exception handler for Tortoise ValidationError

goosebit/api/v1/settings/routes.py

@@ -1,6 +1,6 @@
 from fastapi import APIRouter
 
-from goosebit.auth.permissions import GOOSEBIT_PERMISSIONS, Permission
+from goosebit.auth.permissions import HANDLER, Permission
 
 from . import users
 
@@ -10,5 +10,5 @@
 
 
 @router.get("/permissions", response_model_exclude_none=True)
-async def settings_permissions_get() -> Permission:
-    return GOOSEBIT_PERMISSIONS
+async def settings_permissions_get() -> list[Permission]:
+    return HANDLER.permissions

goosebit/auth/permissions.py

@@ -78,3 +78,17 @@ def parent(self) -> str | None:
     description="Full access to GooseBit",
     sub_permissions=[DEVICE_PERMISSIONS, SOFTWARE_PERMISSIONS, ROLLOUT_PERMISSIONS, SETTING_PERMISSIONS],
 )
+
+
+class PermissionHandler:
+    def __init__(self, permissions: list[Permission]):
+        self.permissions = permissions
+
+    def append(self, permission: Permission) -> None:
+        self.permissions.append(permission)
+
+    def extend(self, permissions: list[Permission]) -> None:
+        self.permissions.extend(permissions)
+
+
+HANDLER = PermissionHandler([GOOSEBIT_PERMISSIONS])

goosebit/ui/static/js/settings.js

@@ -196,29 +196,29 @@ function updateUsersList() {
 async function createPermissions() {
     const permissions = await get_request("/ui/bff/settings/permissions");
 
-    innerAccordion = document.createElement("div");
+    const innerAccordion = document.createElement("div");
     innerAccordion.classList = "accordion-body p-0";
 
-    for (innerPermission in permissions.sub_permissions) {
-        dropdown = createPermissionDropdown(permissions.sub_permissions[innerPermission]);
-        innerAccordion.innerHTML += dropdown;
+    for (innerPermission in permissions) {
+        const dropdown = createPermissionDropdown(permissions[innerPermission]);
+        innerAccordion.insertAdjacentHTML("beforeend", dropdown);
     }
 
     return `<div class="input-group d-flex">
         <div class="input-group-text p-2 px-3">
-            <input class="form-check-input mt-0 ignore-validation" type="checkbox" value="${permissions.value}"  id="${permissions.value}-checkbox" onchange="permissionCheckOnUpdate(this)">
+            <input class="form-check-input mt-0 ignore-validation" type="checkbox" value="*"  id="all-checkbox" onchange="permissionCheckOnUpdate(this)">
         </div>
         <div class="d-flex flex-fill accordion rounded-start-0">
             <div class="accordion-item w-100 rounded-start-0">
                 <div class="accordion-header w-100">
                     <button class="accordion-button collapsed py-2 rounded-start-0"
                         type="button"
                         data-bs-toggle="collapse"
-                        data-bs-target="#${permissions.value}">
-                        ${permissions.description}
+                        data-bs-target="#all">
+                        Full access to Goosebit and all plugins
                     </button>
                 </div>
-                <div id="${permissions.value}" class="accordion-collapse collapse">
+                <div id="all" class="accordion-collapse collapse">
                     ${innerAccordion.outerHTML}
                 </div>
             </div>
@@ -238,18 +238,19 @@ function createPermissionDropdown(permission) {
         </div>`;
     }
 
-    subAccordion = document.createElement("div");
+    const subAccordion = document.createElement("div");
     subAccordion.classList = "accordion-body p-0";
 
-    for (innerPermission in permission.sub_permissions) {
-        dropdown = createPermissionDropdown(permission.sub_permissions[innerPermission]);
-        subAccordion.innerHTML += dropdown;
+    for (innerPermission of permission.sub_permissions) {
+        const dropdown = createPermissionDropdown(innerPermission);
+        subAccordion.insertAdjacentHTML("beforeend", dropdown);
     }
-    permissionId = permission.value.replaceAll(".", "-");
+    const permissionId = permission.value.replaceAll(".", "-");
+    const parentPermission = permission.parent ? permission.parent : "*";
 
     return `<div class="input-group d-flex border-top">
         <div class="input-group-text p-2 px-3 rounded-0 border-0 border-start">
-            <input class="form-check-input mt-0" type="checkbox" value="${permission.value}" id="${permissionId}-checkbox" data-permission-parent="${permission.parent}" onchange="permissionCheckOnUpdate(this)">
+            <input class="form-check-input mt-0" type="checkbox" value="${permission.value}" id="${permissionId}-checkbox" data-permission-parent="${parentPermission}" onchange="permissionCheckOnUpdate(this)">
         </div>
         <div class="d-flex flex-fill accordion accordion-flush border-start">
             <div class="accordion-item w-100 rounded-start-0">

goosebit/ui/templates/settings.html.jinja

@@ -37,7 +37,9 @@
                                 data-bs-dismiss="modal"
                                 aria-label="Close"></button>
                     </div>
-                    <form id="create-user-form" class="needs-validation" novalidate>
+                    <form id="create-user-form"
+                          class="h-100 overflow-auto needs-validation"
+                          novalidate>
                         <div class="modal-body">
                             <div class="input-group mb-3 has-validation">
                                 <span class="input-group-text">Username</span>