NAS-130786: Enclosure page shouldn't break when there is no enclosure (…

…#10556) * NAS-130786: Enclosure page shouldn't break when there is no enclosure * NAS-130786: PR update * NAS-130786: PR update * NAS-130786: PR update * NAS-130786: PR update
truenas · Aug 28, 2024 · d0159ca · d0159ca
1 parent b5a4f7c
commit d0159ca
Show file tree

Hide file tree

Showing 93 changed files with 209 additions and 7 deletions.
diff --git a/.../pages/system/enclosure/components/enclosure-dashboard/enclosure-dashboard.component.html b/.../pages/system/enclosure/components/enclosure-dashboard/enclosure-dashboard.component.html
@@ -17,4 +17,6 @@
 
 @if (selectedEnclosure()) {
   <router-outlet></router-outlet>
+} @else {
+  <ix-empty [conf]="emptyDashboardConf"></ix-empty>
 }
diff --git a/.../pages/system/enclosure/components/enclosure-dashboard/enclosure-dashboard.component.scss b/.../pages/system/enclosure/components/enclosure-dashboard/enclosure-dashboard.component.scss
@@ -0,0 +1,3 @@
+ix-empty {
+  height: inherit;
+}
diff --git a/...ges/system/enclosure/components/enclosure-dashboard/enclosure-dashboard.component.spec.ts b/...ges/system/enclosure/components/enclosure-dashboard/enclosure-dashboard.component.spec.ts
@@ -4,10 +4,11 @@ import {
   mockProvider,
   SpectatorRouting,
 } from '@ngneat/spectator/jest';
+import { MockComponent } from 'ng-mocks';
 import { of } from 'rxjs';
 import { mockAuth } from 'app/core/testing/utils/mock-auth.utils';
 import { mockCall, mockWebSocket } from 'app/core/testing/utils/mock-websocket.utils';
-import { DashboardEnclosure } from 'app/interfaces/enclosure.interface';
+import { EmptyComponent } from 'app/modules/empty/empty.component';
 import {
   EnclosureDashboardComponent,
 } from 'app/pages/system/enclosure/components/enclosure-dashboard/enclosure-dashboard.component';
@@ -18,13 +19,12 @@ describe('EnclosureDashboardComponent', () => {
   const createComponent = createRoutingFactory({
     component: EnclosureDashboardComponent,
     shallow: true,
+    declarations: [
+      MockComponent(EmptyComponent),
+    ],
     componentProviders: [
       mockProvider(EnclosureStore, {
-        selectedEnclosure: () => ({
-          id: 'enclosure-id',
-          name: 'M50',
-          label: 'Current label',
-        } as DashboardEnclosure),
+        selectedEnclosure: jest.fn(),
         initiate: jest.fn(),
         listenForDiskUpdates: jest.fn(() => of()),
         selectEnclosure: jest.fn(),
@@ -43,6 +43,15 @@ describe('EnclosureDashboardComponent', () => {
     spectator = createComponent();
   });
 
+  it('shows empty message when no enclosure is available', () => {
+    spectator.inject(EnclosureStore, true).selectedEnclosure.mockReturnValueOnce(undefined);
+
+    spectator.detectChanges();
+
+    const emptyComponent = spectator.query(EmptyComponent);
+    expect(emptyComponent).toExist();
+  });
+
   it('initializes store when component is initialized', () => {
     expect(spectator.inject(EnclosureStore, true).initiate).toHaveBeenCalled();
   });

diff --git a/...pp/pages/system/enclosure/components/enclosure-dashboard/enclosure-dashboard.component.ts b/...pp/pages/system/enclosure/components/enclosure-dashboard/enclosure-dashboard.component.ts
@@ -3,6 +3,9 @@ import {
 } from '@angular/core';
 import { ActivatedRoute } from '@angular/router';
 import { UntilDestroy, untilDestroyed } from '@ngneat/until-destroy';
+import { TranslateService } from '@ngx-translate/core';
+import { EmptyType } from 'app/enums/empty-type.enum';
+import { EmptyConfig } from 'app/interfaces/empty-config.interface';
 import { EnclosureStore } from 'app/pages/system/enclosure/services/enclosure.store';
 import { WebSocketService } from 'app/services/ws.service';
 
@@ -11,6 +14,7 @@ import { WebSocketService } from 'app/services/ws.service';
   selector: 'ix-enclosure-dashboard',
   templateUrl: './enclosure-dashboard.component.html',
   changeDetection: ChangeDetectionStrategy.OnPush,
+  styleUrls: ['./enclosure-dashboard.component.scss'],
   providers: [
     EnclosureStore,
   ],
@@ -20,10 +24,18 @@ export class EnclosureDashboardComponent {
 
   readonly selectedEnclosure = this.enclosureStore.selectedEnclosure;
 
+  emptyDashboardConf: EmptyConfig = {
+    type: EmptyType.NoPageData,
+    large: true,
+    title: this.translate.instant('Enclosure Unavailable'),
+    message: this.translate.instant('We’re unable to access the enclosure at the moment. Please ensure it’s connected properly and reload the page.'),
+  };
+
   constructor(
     private enclosureStore: EnclosureStore,
     private route: ActivatedRoute,
     private ws: WebSocketService,
+    private translate: TranslateService,
   ) {
     this.enclosureStore.initiate();
     this.enclosureStore.listenForDiskUpdates().pipe(untilDestroyed(this)).subscribe();

diff --git a/src/app/pages/system/enclosure/utils/get-default-side.utils.ts b/src/app/pages/system/enclosure/utils/get-default-side.utils.ts
@@ -2,5 +2,5 @@ import { DashboardEnclosure } from 'app/interfaces/enclosure.interface';
 import { EnclosureSide } from 'app/pages/system/enclosure/utils/supported-enclosures';
 
 export function getDefaultSide(enclosure: DashboardEnclosure): EnclosureSide {
-  return enclosure.top_loaded ? EnclosureSide.Top : EnclosureSide.Front;
+  return enclosure?.top_loaded ? EnclosureSide.Top : EnclosureSide.Front;
 }
diff --git a/src/assets/i18n/af.json b/src/assets/i18n/af.json
@@ -1561,6 +1561,7 @@
   "Enclosure Options": "",
   "Enclosure Read": "",
   "Enclosure Services Controller Electronics": "",
+  "Enclosure Unavailable": "",
   "Enclosure Write": "",
   "Encode information in less space than the  original data occupies. It is recommended to choose a compression algorithm  that balances disk performance with the amount of saved space.<br> <i>LZ4</i> is  generally recommended as it maximizes performance and dynamically identifies  the best files to compress.<br> <i>GZIP</i> options range from 1 for least  compression, best performance, through 9 for maximum compression with  greatest performance impact.<br> <i>ZLE</i> is a fast algorithm that only  eliminates runs of zeroes.": "",
   "Encrypted Datasets": "",
@@ -4803,6 +4804,7 @@
   "Wednesday": "",
   "Week(s)": "",
   "Weeks": "",
+  "We’re unable to access the enclosure at the moment. Please ensure it’s connected properly and reload the page.": "",
   "What and When": "",
   "What and Where": "",
   "When": "",

diff --git a/src/assets/i18n/ar.json b/src/assets/i18n/ar.json
@@ -1561,6 +1561,7 @@
   "Enclosure Options": "",
   "Enclosure Read": "",
   "Enclosure Services Controller Electronics": "",
+  "Enclosure Unavailable": "",
   "Enclosure Write": "",
   "Encode information in less space than the  original data occupies. It is recommended to choose a compression algorithm  that balances disk performance with the amount of saved space.<br> <i>LZ4</i> is  generally recommended as it maximizes performance and dynamically identifies  the best files to compress.<br> <i>GZIP</i> options range from 1 for least  compression, best performance, through 9 for maximum compression with  greatest performance impact.<br> <i>ZLE</i> is a fast algorithm that only  eliminates runs of zeroes.": "",
   "Encrypted Datasets": "",
@@ -4803,6 +4804,7 @@
   "Wednesday": "",
   "Week(s)": "",
   "Weeks": "",
+  "We’re unable to access the enclosure at the moment. Please ensure it’s connected properly and reload the page.": "",
   "What and When": "",
   "What and Where": "",
   "When": "",

diff --git a/src/assets/i18n/ast.json b/src/assets/i18n/ast.json
@@ -1561,6 +1561,7 @@
   "Enclosure Options": "",
   "Enclosure Read": "",
   "Enclosure Services Controller Electronics": "",
+  "Enclosure Unavailable": "",
   "Enclosure Write": "",
   "Encode information in less space than the  original data occupies. It is recommended to choose a compression algorithm  that balances disk performance with the amount of saved space.<br> <i>LZ4</i> is  generally recommended as it maximizes performance and dynamically identifies  the best files to compress.<br> <i>GZIP</i> options range from 1 for least  compression, best performance, through 9 for maximum compression with  greatest performance impact.<br> <i>ZLE</i> is a fast algorithm that only  eliminates runs of zeroes.": "",
   "Encrypted Datasets": "",
@@ -4803,6 +4804,7 @@
   "Wednesday": "",
   "Week(s)": "",
   "Weeks": "",
+  "We’re unable to access the enclosure at the moment. Please ensure it’s connected properly and reload the page.": "",
   "What and When": "",
   "What and Where": "",
   "When": "",

diff --git a/src/assets/i18n/az.json b/src/assets/i18n/az.json
@@ -1561,6 +1561,7 @@
   "Enclosure Options": "",
   "Enclosure Read": "",
   "Enclosure Services Controller Electronics": "",
+  "Enclosure Unavailable": "",
   "Enclosure Write": "",
   "Encode information in less space than the  original data occupies. It is recommended to choose a compression algorithm  that balances disk performance with the amount of saved space.<br> <i>LZ4</i> is  generally recommended as it maximizes performance and dynamically identifies  the best files to compress.<br> <i>GZIP</i> options range from 1 for least  compression, best performance, through 9 for maximum compression with  greatest performance impact.<br> <i>ZLE</i> is a fast algorithm that only  eliminates runs of zeroes.": "",
   "Encrypted Datasets": "",
@@ -4803,6 +4804,7 @@
   "Wednesday": "",
   "Week(s)": "",
   "Weeks": "",
+  "We’re unable to access the enclosure at the moment. Please ensure it’s connected properly and reload the page.": "",
   "What and When": "",
   "What and Where": "",
   "When": "",

diff --git a/src/assets/i18n/be.json b/src/assets/i18n/be.json
@@ -1561,6 +1561,7 @@
   "Enclosure Options": "",
   "Enclosure Read": "",
   "Enclosure Services Controller Electronics": "",
+  "Enclosure Unavailable": "",
   "Enclosure Write": "",
   "Encode information in less space than the  original data occupies. It is recommended to choose a compression algorithm  that balances disk performance with the amount of saved space.<br> <i>LZ4</i> is  generally recommended as it maximizes performance and dynamically identifies  the best files to compress.<br> <i>GZIP</i> options range from 1 for least  compression, best performance, through 9 for maximum compression with  greatest performance impact.<br> <i>ZLE</i> is a fast algorithm that only  eliminates runs of zeroes.": "",
   "Encrypted Datasets": "",
@@ -4803,6 +4804,7 @@
   "Wednesday": "",
   "Week(s)": "",
   "Weeks": "",
+  "We’re unable to access the enclosure at the moment. Please ensure it’s connected properly and reload the page.": "",
   "What and When": "",
   "What and Where": "",
   "When": "",

diff --git a/src/assets/i18n/bg.json b/src/assets/i18n/bg.json
@@ -1561,6 +1561,7 @@
   "Enclosure Options": "",
   "Enclosure Read": "",
   "Enclosure Services Controller Electronics": "",
+  "Enclosure Unavailable": "",
   "Enclosure Write": "",
   "Encode information in less space than the  original data occupies. It is recommended to choose a compression algorithm  that balances disk performance with the amount of saved space.<br> <i>LZ4</i> is  generally recommended as it maximizes performance and dynamically identifies  the best files to compress.<br> <i>GZIP</i> options range from 1 for least  compression, best performance, through 9 for maximum compression with  greatest performance impact.<br> <i>ZLE</i> is a fast algorithm that only  eliminates runs of zeroes.": "",
   "Encrypted Datasets": "",
@@ -4803,6 +4804,7 @@
   "Wednesday": "",
   "Week(s)": "",
   "Weeks": "",
+  "We’re unable to access the enclosure at the moment. Please ensure it’s connected properly and reload the page.": "",
   "What and When": "",
   "What and Where": "",
   "When": "",

diff --git a/src/assets/i18n/bn.json b/src/assets/i18n/bn.json
@@ -1561,6 +1561,7 @@
   "Enclosure Options": "",
   "Enclosure Read": "",
   "Enclosure Services Controller Electronics": "",
+  "Enclosure Unavailable": "",
   "Enclosure Write": "",
   "Encode information in less space than the  original data occupies. It is recommended to choose a compression algorithm  that balances disk performance with the amount of saved space.<br> <i>LZ4</i> is  generally recommended as it maximizes performance and dynamically identifies  the best files to compress.<br> <i>GZIP</i> options range from 1 for least  compression, best performance, through 9 for maximum compression with  greatest performance impact.<br> <i>ZLE</i> is a fast algorithm that only  eliminates runs of zeroes.": "",
   "Encrypted Datasets": "",
@@ -4803,6 +4804,7 @@
   "Wednesday": "",
   "Week(s)": "",
   "Weeks": "",
+  "We’re unable to access the enclosure at the moment. Please ensure it’s connected properly and reload the page.": "",
   "What and When": "",
   "What and Where": "",
   "When": "",

diff --git a/src/assets/i18n/br.json b/src/assets/i18n/br.json
@@ -1561,6 +1561,7 @@
   "Enclosure Options": "",
   "Enclosure Read": "",
   "Enclosure Services Controller Electronics": "",
+  "Enclosure Unavailable": "",
   "Enclosure Write": "",
   "Encode information in less space than the  original data occupies. It is recommended to choose a compression algorithm  that balances disk performance with the amount of saved space.<br> <i>LZ4</i> is  generally recommended as it maximizes performance and dynamically identifies  the best files to compress.<br> <i>GZIP</i> options range from 1 for least  compression, best performance, through 9 for maximum compression with  greatest performance impact.<br> <i>ZLE</i> is a fast algorithm that only  eliminates runs of zeroes.": "",
   "Encrypted Datasets": "",
@@ -4803,6 +4804,7 @@
   "Wednesday": "",
   "Week(s)": "",
   "Weeks": "",
+  "We’re unable to access the enclosure at the moment. Please ensure it’s connected properly and reload the page.": "",
   "What and When": "",
   "What and Where": "",
   "When": "",

diff --git a/src/assets/i18n/bs.json b/src/assets/i18n/bs.json
@@ -1561,6 +1561,7 @@
   "Enclosure Options": "",
   "Enclosure Read": "",
   "Enclosure Services Controller Electronics": "",
+  "Enclosure Unavailable": "",
   "Enclosure Write": "",
   "Encode information in less space than the  original data occupies. It is recommended to choose a compression algorithm  that balances disk performance with the amount of saved space.<br> <i>LZ4</i> is  generally recommended as it maximizes performance and dynamically identifies  the best files to compress.<br> <i>GZIP</i> options range from 1 for least  compression, best performance, through 9 for maximum compression with  greatest performance impact.<br> <i>ZLE</i> is a fast algorithm that only  eliminates runs of zeroes.": "",
   "Encrypted Datasets": "",
@@ -4803,6 +4804,7 @@
   "Wednesday": "",
   "Week(s)": "",
   "Weeks": "",
+  "We’re unable to access the enclosure at the moment. Please ensure it’s connected properly and reload the page.": "",
   "What and When": "",
   "What and Where": "",
   "When": "",

diff --git a/src/assets/i18n/ca.json b/src/assets/i18n/ca.json
@@ -1561,6 +1561,7 @@
   "Enclosure Options": "",
   "Enclosure Read": "",
   "Enclosure Services Controller Electronics": "",
+  "Enclosure Unavailable": "",
   "Enclosure Write": "",
   "Encode information in less space than the  original data occupies. It is recommended to choose a compression algorithm  that balances disk performance with the amount of saved space.<br> <i>LZ4</i> is  generally recommended as it maximizes performance and dynamically identifies  the best files to compress.<br> <i>GZIP</i> options range from 1 for least  compression, best performance, through 9 for maximum compression with  greatest performance impact.<br> <i>ZLE</i> is a fast algorithm that only  eliminates runs of zeroes.": "",
   "Encrypted Datasets": "",
@@ -4803,6 +4804,7 @@
   "Wednesday": "",
   "Week(s)": "",
   "Weeks": "",
+  "We’re unable to access the enclosure at the moment. Please ensure it’s connected properly and reload the page.": "",
   "What and When": "",
   "What and Where": "",
   "When": "",

diff --git a/src/assets/i18n/cs.json b/src/assets/i18n/cs.json
@@ -1456,6 +1456,7 @@
   "Enclosure Options": "",
   "Enclosure Read": "",
   "Enclosure Services Controller Electronics": "",
+  "Enclosure Unavailable": "",
   "Enclosure Write": "",
   "Encode information in less space than the  original data occupies. It is recommended to choose a compression algorithm  that balances disk performance with the amount of saved space.<br> <i>LZ4</i> is  generally recommended as it maximizes performance and dynamically identifies  the best files to compress.<br> <i>GZIP</i> options range from 1 for least  compression, best performance, through 9 for maximum compression with  greatest performance impact.<br> <i>ZLE</i> is a fast algorithm that only  eliminates runs of zeroes.": "",
   "Encrypted Datasets": "",
@@ -4251,6 +4252,7 @@
   "Wednesday": "",
   "Week(s)": "",
   "Weeks": "",
+  "We’re unable to access the enclosure at the moment. Please ensure it’s connected properly and reload the page.": "",
   "What and When": "",
   "What and Where": "",
   "When a group is selected, the <i>root</i> user is also limited to the permissions of that group.": "",

diff --git a/src/assets/i18n/cy.json b/src/assets/i18n/cy.json
@@ -1561,6 +1561,7 @@
   "Enclosure Options": "",
   "Enclosure Read": "",
   "Enclosure Services Controller Electronics": "",
+  "Enclosure Unavailable": "",
   "Enclosure Write": "",
   "Encode information in less space than the  original data occupies. It is recommended to choose a compression algorithm  that balances disk performance with the amount of saved space.<br> <i>LZ4</i> is  generally recommended as it maximizes performance and dynamically identifies  the best files to compress.<br> <i>GZIP</i> options range from 1 for least  compression, best performance, through 9 for maximum compression with  greatest performance impact.<br> <i>ZLE</i> is a fast algorithm that only  eliminates runs of zeroes.": "",
   "Encrypted Datasets": "",
@@ -4803,6 +4804,7 @@
   "Wednesday": "",
   "Week(s)": "",
   "Weeks": "",
+  "We’re unable to access the enclosure at the moment. Please ensure it’s connected properly and reload the page.": "",
   "What and When": "",
   "What and Where": "",
   "When": "",

diff --git a/src/assets/i18n/da.json b/src/assets/i18n/da.json
@@ -1561,6 +1561,7 @@
   "Enclosure Options": "",
   "Enclosure Read": "",
   "Enclosure Services Controller Electronics": "",
+  "Enclosure Unavailable": "",
   "Enclosure Write": "",
   "Encode information in less space than the  original data occupies. It is recommended to choose a compression algorithm  that balances disk performance with the amount of saved space.<br> <i>LZ4</i> is  generally recommended as it maximizes performance and dynamically identifies  the best files to compress.<br> <i>GZIP</i> options range from 1 for least  compression, best performance, through 9 for maximum compression with  greatest performance impact.<br> <i>ZLE</i> is a fast algorithm that only  eliminates runs of zeroes.": "",
   "Encrypted Datasets": "",
@@ -4803,6 +4804,7 @@
   "Wednesday": "",
   "Week(s)": "",
   "Weeks": "",
+  "We’re unable to access the enclosure at the moment. Please ensure it’s connected properly and reload the page.": "",
   "What and When": "",
   "What and Where": "",
   "When": "",

diff --git a/src/assets/i18n/de.json b/src/assets/i18n/de.json
@@ -1093,6 +1093,7 @@
   "Enclosure Options": "",
   "Enclosure Read": "",
   "Enclosure Services Controller Electronics": "",
+  "Enclosure Unavailable": "",
   "Enclosure Write": "",
   "Encode information in less space than the  original data occupies. It is recommended to choose a compression algorithm  that balances disk performance with the amount of saved space.<br> <i>LZ4</i> is  generally recommended as it maximizes performance and dynamically identifies  the best files to compress.<br> <i>GZIP</i> options range from 1 for least  compression, best performance, through 9 for maximum compression with  greatest performance impact.<br> <i>ZLE</i> is a fast algorithm that only  eliminates runs of zeroes.": "",
   "Encrypted Datasets": "",
@@ -3467,6 +3468,7 @@
   "Webhook URL": "",
   "Wednesday": "",
   "Week(s)": "",
+  "We’re unable to access the enclosure at the moment. Please ensure it’s connected properly and reload the page.": "",
   "What and When": "",
   "When a group is selected, the <i>root</i> user is also limited to the permissions of that group.": "",
   "When a user is selected, the <i>root</i> user is limited to the permissions of that user.": "",

diff --git a/src/assets/i18n/dsb.json b/src/assets/i18n/dsb.json
@@ -1561,6 +1561,7 @@
   "Enclosure Options": "",
   "Enclosure Read": "",
   "Enclosure Services Controller Electronics": "",
+  "Enclosure Unavailable": "",
   "Enclosure Write": "",
   "Encode information in less space than the  original data occupies. It is recommended to choose a compression algorithm  that balances disk performance with the amount of saved space.<br> <i>LZ4</i> is  generally recommended as it maximizes performance and dynamically identifies  the best files to compress.<br> <i>GZIP</i> options range from 1 for least  compression, best performance, through 9 for maximum compression with  greatest performance impact.<br> <i>ZLE</i> is a fast algorithm that only  eliminates runs of zeroes.": "",
   "Encrypted Datasets": "",
@@ -4803,6 +4804,7 @@
   "Wednesday": "",
   "Week(s)": "",
   "Weeks": "",
+  "We’re unable to access the enclosure at the moment. Please ensure it’s connected properly and reload the page.": "",
   "What and When": "",
   "What and Where": "",
   "When": "",