491 [FEAT] Allow disks to be hidden/archived

- Add archived to device type & db - Add archive/unarchive handlers to webapp backend - Add archive toggle & styling to webapp frontend
2025-02-21 09:23:48 +01:00
parent a58f9445c1
commit 600cd153e0
24 changed files with 390 additions and 25 deletions
@@ -0,0 +1,11 @@
+<h2 mat-dialog-title>Archive {{data.title}}?</h2>
+<mat-dialog-content>This will remove the device from Scrutiny dashboard, unless you toggle show archived. <strong>Any data about the device
+    itself will remain untouched.</strong></mat-dialog-content>
+<mat-dialog-actions>
+    <button mat-button mat-dialog-close>Cancel</button>
+    <button class="yellow-600" mat-button (click)="onArchiveClick()">
+        <mat-icon class="icon-size-20 mr-3"
+                  [svgIcon]="'archive'"></mat-icon>
+        Archive
+    </button>
+</mat-dialog-actions>
@@ -0,0 +1,64 @@
+import {async, ComponentFixture, TestBed} from '@angular/core/testing';
+
+import {DashboardDeviceArchiveDialogComponent} from './dashboard-device-archive-dialog.component';
+import {HttpClientModule} from '@angular/common/http';
+import {MAT_DIALOG_DATA, MatDialogModule, MatDialogRef} from '@angular/material/dialog';
+import {MatButtonModule} from '@angular/material/button';
+import {MatIconModule} from '@angular/material/icon';
+import {SharedModule} from '../../../shared/shared.module';
+import {DashboardDeviceArchiveDialogService} from './dashboard-device-archive-dialog.service';
+import {of} from 'rxjs';
+
+
+describe('DashboardDeviceArchiveDialogComponent', () => {
+    let component: DashboardDeviceArchiveDialogComponent;
+    let fixture: ComponentFixture<DashboardDeviceArchiveDialogComponent>;
+
+    const matDialogRefSpy = jasmine.createSpyObj('MatDialogRef', ['closeDialog', 'close']);
+    const dashboardDeviceArchiveDialogServiceSpy = jasmine.createSpyObj('DashboardDeviceArchiveDialogService', ['archiveDevice']);
+
+    beforeEach(async(() => {
+        TestBed.configureTestingModule({
+            imports: [
+                HttpClientModule,
+                MatDialogModule,
+                MatButtonModule,
+                MatIconModule,
+                SharedModule,
+            ],
+            providers: [
+                {provide: MatDialogRef, useValue: matDialogRefSpy},
+                {provide: MAT_DIALOG_DATA, useValue: {wwn: 'test-wwn', title: 'my-test-device-title'}},
+                {provide: DashboardDeviceArchiveDialogService, useValue: dashboardDeviceArchiveDialogServiceSpy}
+            ],
+            declarations: [DashboardDeviceArchiveDialogComponent]
+        })
+            .compileComponents()
+    }));
+
+    beforeEach(() => {
+        fixture = TestBed.createComponent(DashboardDeviceArchiveDialogComponent);
+        component = fixture.componentInstance;
+        fixture.detectChanges();
+    });
+
+    it('should create', () => {
+        expect(component).toBeTruthy();
+    });
+
+    it('should close the component if cancel is clicked', () => {
+        matDialogRefSpy.closeDialog.calls.reset();
+        matDialogRefSpy.closeDialog()
+        expect(matDialogRefSpy.closeDialog).toHaveBeenCalled();
+    });
+
+    it('should attempt to archive device if archive is clicked', () => {
+        dashboardDeviceArchiveDialogServiceSpy.archiveDevice.and.returnValue(of({'success': true}));
+
+        component.onArchiveClick()
+        expect(dashboardDeviceArchiveDialogServiceSpy.archiveDevice).toHaveBeenCalledWith('test-wwn');
+        expect(dashboardDeviceArchiveDialogServiceSpy.archiveDevice.calls.count())
+            .withContext('one call')
+            .toBe(1);
+    });
+});
@@ -0,0 +1,29 @@
+import {Component, Inject, OnInit} from '@angular/core';
+import {MAT_DIALOG_DATA, MatDialogRef} from '@angular/material/dialog';
+import {DashboardDeviceArchiveDialogService} from 'app/layout/common/dashboard-device-archive-dialog/dashboard-device-archive-dialog.service';
+
+@Component({
+  selector: 'app-dashboard-device-archive-dialog',
+  templateUrl: './dashboard-device-archive-dialog.component.html',
+  styleUrls: ['./dashboard-device-archive-dialog.component.scss'],
+})
+export class DashboardDeviceArchiveDialogComponent implements OnInit {
+
+    constructor(
+        public dialogRef: MatDialogRef<DashboardDeviceArchiveDialogComponent>,
+        @Inject(MAT_DIALOG_DATA) public data: {wwn: string, title: string},
+        private _archiveService: DashboardDeviceArchiveDialogService,
+    ) {
+    }
+
+  ngOnInit(): void {
+  }
+
+  onArchiveClick(): void {
+      this._archiveService.archiveDevice(this.data.wwn)
+          .subscribe((data) => {
+              this.dialogRef.close(data);
+          });
+
+  }
+}
@@ -0,0 +1,29 @@
+import {NgModule} from '@angular/core';
+import {RouterModule} from '@angular/router';
+import {MatButtonModule} from '@angular/material/button';
+import {MatIconModule} from '@angular/material/icon';
+import {SharedModule} from 'app/shared/shared.module';
+import {dashboardRoutes} from 'app/modules/dashboard/dashboard.routing';
+import {MatDialogModule} from '@angular/material/dialog';
+import {DashboardDeviceArchiveDialogComponent} from './dashboard-device-archive-dialog.component';
+
+@NgModule({
+    declarations: [
+        DashboardDeviceArchiveDialogComponent
+    ],
+    imports: [
+        RouterModule.forChild([]),
+        RouterModule.forChild(dashboardRoutes),
+        MatButtonModule,
+        MatIconModule,
+        SharedModule,
+        MatDialogModule
+    ],
+    exports     : [
+        DashboardDeviceArchiveDialogComponent,
+    ],
+    providers   : []
+})
+export class DashboardDeviceArchiveDialogModule
+{
+}
@@ -0,0 +1,38 @@
+import {Injectable} from '@angular/core';
+import {HttpClient} from '@angular/common/http';
+import {Observable} from 'rxjs';
+import {getBasePath} from 'app/app.routing';
+
+@Injectable({
+    providedIn: 'root'
+})
+export class DashboardDeviceArchiveDialogService
+{
+
+
+    /**
+     * Constructor
+     *
+     * @param {HttpClient} _httpClient
+     */
+    constructor(
+        private _httpClient: HttpClient
+    )
+    {
+    }
+
+    // -----------------------------------------------------------------------------------------------------
+    // @ Public methods
+    // -----------------------------------------------------------------------------------------------------
+
+
+    archiveDevice(wwn: string): Observable<any>
+    {
+        return this._httpClient.post( `${getBasePath()}/api/device/${wwn}/archive`, {});
+    }
+
+    unarchiveDevice(wwn: string): Observable<any>
+    {
+        return this._httpClient.post( `${getBasePath()}/api/device/${wwn}/unarchive`, {});
+    }
+}