NAS-132301 / 25.04 / Adapt changes for boot environments (#11012)

* NAS-132301: Adapt changes for boot environments * NAS-132301: Adapt changes for boot environments * NAS-132301: Adapt changes for boot environments * NAS-132301: Adapt changes for boot environments * NAS-132301: Adapt changes for boot environments * NAS-132301: Update tests * NAS-132301: Remove legacy eslint settings * NAS-132301: Update tests
truenas · Nov 15, 2024 · 1f6c5cd · 1f6c5cd
1 parent cd50b8d
commit 1f6c5cd
Show file tree

Hide file tree

Showing 108 changed files with 228 additions and 775 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,10 +1,6 @@
 {
-    "vsicons.presets.angular": true,
     "typescript.updateImportsOnFileMove.enabled": "always",
     "typescript.preferences.importModuleSpecifier": "non-relative",
-    "eslint.options": {
-        "extensions": [".ts", ".html"]
-    },
     "eslint.validate": [
         "typescript",
         "html"

diff --git a/src/app/enums/boot-environment-action.enum.ts b/src/app/enums/boot-environment-action.enum.ts
diff --git a/src/app/enums/boot-environment-active.enum.ts b/src/app/enums/boot-environment-active.enum.ts
diff --git a/src/app/interfaces/api/api-call-directory.interface.ts b/src/app/interfaces/api/api-call-directory.interface.ts
@@ -37,12 +37,7 @@ import { AuditConfig, AuditEntry, AuditQueryParams } from 'app/interfaces/audit/
 import { AuthSession } from 'app/interfaces/auth-session.interface';
 import { LoginExOtpTokenQuery, LoginExQuery, LoginExResponse } from 'app/interfaces/auth.interface';
 import { AvailableApp } from 'app/interfaces/available-app.interface';
-import {
-  Bootenv,
-  CreateBootenvParams,
-  SetBootenvAttributeParams,
-  UpdateBootenvParams,
-} from 'app/interfaces/bootenv.interface';
+import { BootenvCloneParams, BootEnvironment, BootenvKeepParams } from 'app/interfaces/boot-environment.interface';
 import {
   CatalogConfig, CatalogApp,
   CatalogUpdate, GetItemDetailsParams,
@@ -350,12 +345,12 @@ export interface ApiCallDirectory {
   'boot.get_state': { params: void; response: PoolInstance };
   'boot.set_scrub_interval': { params: [number]; response: number };
 
-  // Bootenv
-  'bootenv.activate': { params: [string]; response: boolean };
-  'bootenv.create': { params: CreateBootenvParams; response: string };
-  'bootenv.query': { params: QueryParams<Bootenv>; response: Bootenv[] };
-  'bootenv.set_attribute': { params: SetBootenvAttributeParams; response: boolean };
-  'bootenv.update': { params: UpdateBootenvParams; response: string };
+  // Boot Environment
+  'boot.environment.query': { params: QueryParams<BootEnvironment>; response: BootEnvironment[] };
+  'boot.environment.activate': { params: [{ id: string }]; response: unknown };
+  'boot.environment.destroy': { params: [{ id: string }]; response: unknown };
+  'boot.environment.clone': { params: BootenvCloneParams; response: unknown };
+  'boot.environment.keep': { params: BootenvKeepParams; response: unknown };
 
   // Catalog
   'catalog.get_app_details': { params: [name: string, params: GetItemDetailsParams]; response: CatalogApp };

diff --git a/src/app/interfaces/api/api-event-directory.interface.ts b/src/app/interfaces/api/api-event-directory.interface.ts
@@ -2,6 +2,7 @@ import { DockerStatusData } from 'app/enums/docker-config.interface';
 import { FailoverStatus } from 'app/enums/failover-status.enum';
 import { Alert } from 'app/interfaces/alert.interface';
 import { App, AppStats } from 'app/interfaces/app.interface';
+import { BootEnvironment } from 'app/interfaces/boot-environment.interface';
 import { ContainerImage } from 'app/interfaces/container-image.interface';
 import { DirectoryServicesState } from 'app/interfaces/directory-services-state.interface';
 import { Disk } from 'app/interfaces/disk.interface';
@@ -43,4 +44,5 @@ export interface ApiEventDirectory {
   'vm.query': { response: VirtualMachine };
   'zfs.pool.scan': { response: PoolScan };
   'zfs.snapshot.query': { response: ZfsSnapshot };
+  'boot.environment.query': { response: BootEnvironment };
 }
diff --git a/src/app/interfaces/boot-environment.interface.ts b/src/app/interfaces/boot-environment.interface.ts
@@ -0,0 +1,59 @@
+import { ApiTimestamp } from 'app/interfaces/api-date.interface';
+
+export interface BootEnvironment {
+  /**
+   * The name of the boot environment.
+   */
+  id: string;
+
+  /**
+   * The name of the dataset representing the boot environment.
+   */
+  dataset: string;
+
+  /**
+   * If `true`, represents the `currently` running boot environment.
+   */
+  active: boolean;
+
+  /**
+   * If `true`, represents the boot environment that will become the running boot environment at `next boot`.
+   */
+  activated: boolean;
+
+  /**
+   * Represents when the boot environment was created.
+   */
+  created: ApiTimestamp;
+
+  /**
+   * An integer representing the number of bytes used by the boot environment.
+   */
+  used_bytes: number;
+
+  /**
+   * A human-readable string representing the total number of space used by the boot environment.
+   */
+  used: string;
+
+  /**
+   * When set to `false`, will be automatically deleted during an upgrade procedure
+   * if there isn’t enough room on the boot drive to apply said update.
+   */
+  keep: boolean;
+
+  /**
+   * If `true` indicates whether the boot environment may be `activated`.
+   */
+  can_activate: boolean;
+}
+
+export type BootenvCloneParams = [{
+  id: string;
+  target: string;
+}];
+
+export type BootenvKeepParams = [{
+  id: string;
+  value: boolean;
+}];
diff --git a/src/app/interfaces/bootenv.interface.ts b/src/app/interfaces/bootenv.interface.ts
diff --git a/src/app/pages/system/bootenv/boot-pool-delete-dialog/boot-pool-delete-dialog.component.html b/src/app/pages/system/bootenv/boot-pool-delete-dialog/boot-pool-delete-dialog.component.html
@@ -1,6 +1,6 @@
 <h1 matDialogTitle>{{ 'Delete' | translate }}</h1>
 <form class="ix-form-container" [formGroup]="form" (submit)="onSubmit()">
-  @if (!isJobCompleted) {
+  @if (!isJobCompleted()) {
     <p>
       <strong>
         {{ 'The following { n, plural, one {boot environment} other {# boot environments} } will be deleted. Are you sure you want to proceed?' | translate: { n: bulkItems.size } }}
@@ -23,17 +23,15 @@ <h1 matDialogTitle>{{ 'Delete' | translate }}</h1>
 
   <div class="bulk-list">
     @for (bulkItem of bulkItems | keyvalue; track trackByKey($index, bulkItem)) {
-      <ix-bulk-list-item
-        [item]="bulkItem.value"
-      >
+      <ix-bulk-list-item [item]="bulkItem.value">
         <span>{{ bulkItem.value.item.id }}</span>
       </ix-bulk-list-item>
     }
   </div>
 
   <div class="form-actions">
     <div class="form-actions-cell">
-      @if (!isJobCompleted) {
+      @if (!isJobCompleted()) {
         <ix-checkbox
           formControlName="confirm"
           [label]="'Confirm' | translate"
@@ -44,7 +42,7 @@ <h1 matDialogTitle>{{ 'Delete' | translate }}</h1>
 
     <div class="form-actions-cell">
       <ng-container *ixRequiresRoles="requiredRoles">
-        @if (!isJobCompleted) {
+        @if (!isJobCompleted()) {
           <button
             mat-button
             type="submit"
@@ -56,7 +54,7 @@ <h1 matDialogTitle>{{ 'Delete' | translate }}</h1>
           </button>
         }
       </ng-container>
-      @if (!isJobCompleted) {
+      @if (!isJobCompleted()) {
         <button
           mat-button
           type="button"

diff --git a/...pp/pages/system/bootenv/boot-pool-delete-dialog/boot-pool-delete-dialog.component.spec.ts b/...pp/pages/system/bootenv/boot-pool-delete-dialog/boot-pool-delete-dialog.component.spec.ts
@@ -65,10 +65,10 @@ describe('BootPoolDeleteDialogComponent', () => {
 
   it('deletes selected boot environments when form is submitted', async () => {
     const jobArguments = [
-      'bootenv.do_delete',
+      'boot.environment.destroy',
       [
-        ['CLONE'],
-        ['22.12-MASTER-20220808-020013'],
+        [{ id: '25.04.0-MASTER-20241031-104807' }],
+        [{ id: '25.04.0-MASTER-20241105-224807' }],
       ],
     ];
     spectator.inject(MockApiService).mockJob('core.bulk', fakeSuccessfulJob(mockSuccessBulkResponse, jobArguments));
@@ -92,10 +92,10 @@ describe('BootPoolDeleteDialogComponent', () => {
 
   it('checks deleting failures of boot environments when form is submitted', async () => {
     const jobArguments: CoreBulkQuery = [
-      'bootenv.do_delete',
+      'boot.environment.destroy',
       [
-        ['CLONE'],
-        ['22.12-MASTER-20220808-020013'],
+        [{ id: '25.04.0-MASTER-20241031-104807' }],
+        [{ id: '25.04.0-MASTER-20241105-224807' }],
       ],
     ];
     spectator.inject(MockApiService).mockJob('core.bulk', fakeSuccessfulJob(mockFailedBulkResponse, jobArguments));

diff --git a/src/app/pages/system/bootenv/boot-pool-delete-dialog/boot-pool-delete-dialog.component.ts b/src/app/pages/system/bootenv/boot-pool-delete-dialog/boot-pool-delete-dialog.component.ts
@@ -1,6 +1,6 @@
 import { KeyValue, KeyValuePipe } from '@angular/common';
 import {
-  ChangeDetectionStrategy, ChangeDetectorRef, Component, Inject, TrackByFunction,
+  ChangeDetectionStrategy, ChangeDetectorRef, Component, Inject, signal, TrackByFunction,
 } from '@angular/core';
 import { Validators, FormBuilder, ReactiveFormsModule } from '@angular/forms';
 import { MatButton } from '@angular/material/button';
@@ -12,7 +12,7 @@ import { TranslateModule } from '@ngx-translate/core';
 import { filter } from 'rxjs/operators';
 import { RequiresRolesDirective } from 'app/directives/requires-roles/requires-roles.directive';
 import { Role } from 'app/enums/role.enum';
-import { Bootenv } from 'app/interfaces/bootenv.interface';
+import { BootEnvironment } from 'app/interfaces/boot-environment.interface';
 import { CoreBulkResponse } from 'app/interfaces/core-bulk.interface';
 import { Job } from 'app/interfaces/job.interface';
 import { IxCheckboxComponent } from 'app/modules/forms/ix-forms/components/ix-checkbox/ix-checkbox.component';
@@ -48,8 +48,8 @@ export class BootPoolDeleteDialogComponent {
     confirm: [false, [Validators.requiredTrue]],
   });
 
-  isJobCompleted = false;
-  bulkItems = new Map<string, BulkListItem<Bootenv>>();
+  isJobCompleted = signal(false);
+  bulkItems = new Map<string, BulkListItem<BootEnvironment>>();
 
   get successCount(): number {
     return [...this.bulkItems.values()].filter((item) => item.state === BulkListItemState.Success).length;
@@ -59,22 +59,22 @@ export class BootPoolDeleteDialogComponent {
     return [...this.bulkItems.values()].filter((item) => item.state === BulkListItemState.Error).length;
   }
 
-  readonly trackByKey: TrackByFunction<KeyValue<string, BulkListItem<Bootenv>>> = (_, entry) => entry.key;
+  readonly trackByKey: TrackByFunction<KeyValue<string, BulkListItem<BootEnvironment>>> = (_, entry) => entry.key;
 
   constructor(
     private fb: FormBuilder,
     private ws: ApiService,
     private cdr: ChangeDetectorRef,
     private dialogRef: MatDialogRef<BootPoolDeleteDialogComponent>,
-    @Inject(MAT_DIALOG_DATA) public bootenvs: Bootenv[],
+    @Inject(MAT_DIALOG_DATA) public bootenvs: BootEnvironment[],
   ) {
     this.bootenvs.forEach((bootenv) => {
       this.bulkItems.set(bootenv.id, { state: BulkListItemState.Initial, item: bootenv });
     });
   }
 
-  getSelectedNames(selectedBootenvs: Bootenv[]): string[][] {
-    return selectedBootenvs.map((bootenv) => [bootenv.id]);
+  getSelectedNames(selectedBootenvs: BootEnvironment[]): { id: string }[][] {
+    return selectedBootenvs.map(({ id }) => [{ id }]);
   }
 
   onSubmit(): void {
@@ -84,12 +84,12 @@ export class BootPoolDeleteDialogComponent {
       this.bulkItems.set(bootenv.id, { state: BulkListItemState.Running, item: bootenv });
     });
 
-    this.ws.job('core.bulk', ['bootenv.do_delete', bootenvsToDelete]).pipe(
-      filter((job: Job<CoreBulkResponse<void>[], string[][]>) => !!job.result),
+    this.ws.job('core.bulk', ['boot.environment.destroy', bootenvsToDelete]).pipe(
+      filter((job: Job<CoreBulkResponse<void>[], { id: string }[][]>) => !!job.result?.length),
       untilDestroyed(this),
     ).subscribe((response) => {
-      response.arguments[1].forEach((params, index: number) => {
-        const [bootenvId] = params.toString().split(',');
+      response.arguments[1].flat().forEach((params, index: number) => {
+        const bootenvId = params.id;
         const bulkItem = this.bulkItems.get(bootenvId);
         if (bulkItem) {
           const item = response.result[index];
@@ -113,8 +113,7 @@ export class BootPoolDeleteDialogComponent {
           }
         }
       });
-      this.isJobCompleted = true;
-      this.cdr.markForCheck();
+      this.isJobCompleted.set(true);
     });
   }
 }
diff --git a/src/app/pages/system/bootenv/bootenv-form/bootenv-form.component.html b/src/app/pages/system/bootenv/bootenv-form/bootenv-form.component.html
@@ -1,4 +1,8 @@
-<ix-modal-header [requiredRoles]="requiredRoles" [title]="title" [loading]="isFormLoading"></ix-modal-header>
+<ix-modal-header 
+  [requiredRoles]="requiredRoles" 
+  [title]="'Clone Boot Environment' | translate"
+  [loading]="isLoading()"
+></ix-modal-header>
 
 <mat-card>
   <mat-card-content>
@@ -9,21 +13,18 @@
     >
       <ix-fieldset [title]="'Settings' | translate">
         <ix-input
-          formControlName="name"
+          formControlName="target"
           [label]="'Name' | translate"
           [required]="true"
           [tooltip]="tooltips.name"
         ></ix-input>
 
-        @if (operation === Operations.Clone) {
-          <ix-input
-            formControlName="source"
-            [label]="'Source' | translate"
-            [required]="true"
-            [tooltip]="tooltips.source"
-            [class]="Operations.Clone"
-          ></ix-input>
-        }
+        <ix-input
+          formControlName="source"
+          [label]="'Source' | translate"
+          [required]="true"
+          [tooltip]="tooltips.source"
+        ></ix-input>
       </ix-fieldset>
 
       <ix-form-actions>
@@ -33,7 +34,7 @@
           type="submit"
           color="primary"
           ixTest="save"
-          [disabled]="formGroup.invalid || isFormLoading"
+          [disabled]="formGroup.invalid || isLoading()"
         >
           {{ 'Save' | translate }}
         </button>