feat: Add indicator to warn when most t4c licenses are being used

Closes #1784
DSD-DBS · Oct 11, 2024 · ce48bb0 · ce48bb0
1 parent ce0f9de
commit ce48bb0
Show file tree

Hide file tree

Showing 14 changed files with 409 additions and 24 deletions.
diff --git a/backend/capellacollab/settings/modelsources/t4c/license_server/models.py b/backend/capellacollab/settings/modelsources/t4c/license_server/models.py
@@ -59,6 +59,11 @@ class SimpleLicenseServer(T4CLicenseServerBase):
     id: int
 
 
+class PublicLicenseServerWithUsage(core_pydantic.BaseModel):
+    id: int
+    name: str
+    usage: interface.T4CLicenseServerUsage
+
 class T4CLicenseServer(T4CLicenseServerBase):
     id: int
     license_server_version: str | None = None

diff --git a/backend/capellacollab/settings/modelsources/t4c/license_server/routes.py b/backend/capellacollab/settings/modelsources/t4c/license_server/routes.py
@@ -95,11 +95,33 @@ def delete_t4c_license_server(
     crud.delete_t4c_license_server(db, license_server)
 
 
+@router.get(
+    "/usage",
+    response_model=list[models.PublicLicenseServerWithUsage],
+)
+def get_t4c_license_servers_usage(
+    db: orm.Session = fastapi.Depends(database.get_db),
+) -> list[models.PublicLicenseServerWithUsage]:
+    usages = []
+    for license_server in crud.get_t4c_license_servers(db):
+        usage = interface.get_t4c_license_server_usage(
+            license_server.usage_api
+        )
+        usages.append(
+            models.PublicLicenseServerWithUsage(
+                id=license_server.id,
+                name=license_server.name,
+                usage=usage,
+            )
+        )
+    return usages
+
+
 @router.get(
     "/{t4c_license_server_id}/usage",
     response_model=interface.T4CLicenseServerUsage,
 )
-def fetch_t4c_license_server_licenses(
+def get_t4c_license_server_usage(
     license_server: models.DatabaseT4CLicenseServer = fastapi.Depends(
         injectables.get_existing_license_server
     ),

diff --git a/backend/capellacollab/settings/modelsources/t4c/routes.py b/backend/capellacollab/settings/modelsources/t4c/routes.py
@@ -19,13 +19,14 @@
 )
 
 router.include_router(
-    settings_t4c_license_server_routes.admin_router,
+    settings_t4c_license_server_routes.router,
     prefix="/license-servers",
     tags=["Settings - Modelsources - T4C - License Servers"],
 )
 
+
 router.include_router(
-    settings_t4c_license_server_routes.router,
+    settings_t4c_license_server_routes.admin_router,
     prefix="/license-servers",
     tags=["Settings - Modelsources - T4C - License Servers"],
 )
diff --git a/frontend/src/app/openapi/.openapi-generator/FILES b/frontend/src/app/openapi/.openapi-generator/FILES
diff --git a/frontend/src/app/openapi/api/settings-modelsources-t4-c-license-servers.service.ts b/frontend/src/app/openapi/api/settings-modelsources-t4-c-license-servers.service.ts
diff --git a/frontend/src/app/openapi/model/models.ts b/frontend/src/app/openapi/model/models.ts
diff --git a/frontend/src/app/openapi/model/public-license-server-with-usage.ts b/frontend/src/app/openapi/model/public-license-server-with-usage.ts
diff --git a/frontend/src/app/sessions/license-indicator/license-indicator.component.html b/frontend/src/app/sessions/license-indicator/license-indicator.component.html
@@ -0,0 +1,38 @@
+<!--
+ ~ SPDX-FileCopyrightText: Copyright DB InfraGO AG and contributors
+ ~ SPDX-License-Identifier: Apache-2.0
+ -->
+
+@if ((licenseUsageWrapperService.licenseServerUsage$ | async) !== undefined) {
+  @for (
+    licenseServer of licenseUsageWrapperService.licenseServerUsage$ | async;
+    track licenseServer.id
+  ) {
+    @if (licenseServer.usage.free === 0) {
+      <div
+        class="my-1 flex items-center gap-1.5 rounded border bg-red-500 p-1 text-sm text-white shadow"
+      >
+        <mat-icon class="shrink-0">error</mat-icon>
+        <span
+          >All {{ licenseServer.usage.total }} TeamForCapella licenses are
+          currently in use. You will not be able to start a new session until a
+          license is available. Please make sure to terminate your sessions
+          after use.
+        </span>
+      </div>
+    } @else if (licenseServer.usage.free / licenseServer.usage.total < 0.4) {
+      <div
+        class="my-1 flex items-center gap-1.5 rounded border bg-yellow-300 p-1 text-sm shadow"
+      >
+        <mat-icon class="shrink-0">warning</mat-icon>
+        <span
+          >{{ licenseServer.usage.total - licenseServer.usage.free }}/{{
+            licenseServer.usage.total
+          }}
+          TeamForCapella licenses are currently in use. Please make sure to
+          terminate your sessions after use.
+        </span>
+      </div>
+    }
+  }
+}
diff --git a/frontend/src/app/sessions/license-indicator/license-indicator.component.ts b/frontend/src/app/sessions/license-indicator/license-indicator.component.ts
@@ -0,0 +1,18 @@
+/*
+ * SPDX-FileCopyrightText: Copyright DB InfraGO AG and contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { AsyncPipe } from '@angular/common';
+import { Component } from '@angular/core';
+import { MatIcon } from '@angular/material/icon';
+import { LicenseUsageWrapperService } from './license-usage.service';
+
+@Component({
+  selector: 'app-license-indicator',
+  standalone: true,
+  imports: [MatIcon, AsyncPipe],
+  templateUrl: './license-indicator.component.html',
+})
+export class LicenseIndicatorComponent {
+  constructor(public licenseUsageWrapperService: LicenseUsageWrapperService) {}
+}