NAS-119035 / 22.12 / enable no-shadow linter rule (#7334)

.eslintrc.js

@@ -131,7 +131,7 @@ module.exports = {
         ],
         "@typescript-eslint/restrict-template-expressions": ["error", { allowNumber: true, allowAny: true }],
 
-        // TODO: Aibnb rules that are disabled for now as they cannot be fixed automatically
+        // TODO: Airbnb rules that are disabled for now as they cannot be fixed automatically
         "no-underscore-dangle": "off",
         "consistent-return": "off",
         "no-plusplus": "off",
@@ -153,7 +153,6 @@ module.exports = {
         "no-param-reassign": "off",
         "@typescript-eslint/no-loop-func": "off",
         "no-await-in-loop": "off",
-        "@typescript-eslint/no-shadow": "off",
         "no-multi-str": "off",
         "no-mixed-operators": ["error", {
           groups: [

src/app/core/testing/interfaces/mock-websocket-responses.interface.ts

@@ -2,6 +2,7 @@ import { ApiMethod } from 'app/interfaces/api-directory.interface';
 import { Job } from 'app/interfaces/job.interface';
 
 export enum MockWebsocketResponseType {
+  // eslint-disable-next-line @typescript-eslint/no-shadow
   Job = 'job',
   Call = 'call',
 }
@@ -15,5 +16,5 @@ export interface MockWebsocketCallResponse {
 export interface MockWebsocketJobResponse {
   type: MockWebsocketResponseType.Job;
   method: ApiMethod;
-  response: Job<unknown>;
+  response: Job;
 }

src/app/helpers/options.helper.ts

@@ -4,8 +4,8 @@ import { map } from 'rxjs/operators';
 import { Choices } from 'app/interfaces/choices.interface';
 import { MapOption, Option } from 'app/interfaces/option.interface';
 
-export function mapToOptions(map: Map<string, string>, translate: TranslateService): Option[] {
-  return Array.from(map.entries()).map(([value, label]) => ({ label: translate.instant(label), value }));
+export function mapToOptions(optionMap: Map<string, string>, translate: TranslateService): Option[] {
+  return Array.from(optionMap.entries()).map(([value, label]) => ({ label: translate.instant(label), value }));
 }
 
 /**

src/app/interfaces/dataset.interface.ts

@@ -65,7 +65,6 @@ export interface Dataset {
   // Absent if extra.retrieve_children is false
   children?: Dataset[];
 
-  // TODO: Need to confirm that these properties are valid backend properties
   refquota_critical?: ZfsProperty<number>;
   refquota_warning?: ZfsProperty<number>;
   quota_critical?: ZfsProperty<number>;

src/app/interfaces/system-info.interface.ts

@@ -35,7 +35,7 @@ export interface SystemLicense {
   features: LicenseFeature[];
   legacy_contract_hardware: unknown;
   legacy_contract_software: unknown;
-  model: string; // TODO: Enum?
+  model: string;
   system_serial: string;
   system_serial_ha: string;
 }

src/app/modules/alerts/components/alerts-panel/alerts-panel.component.spec.ts

@@ -143,8 +143,8 @@ describe('AlertsPanelComponent', () => {
   it('adds an alert when websocket alert.list subscription sends an "add" event', () => {
     spectator.inject(Store).dispatch(adminUiInitialized());
 
-    const mockWebsocket = spectator.inject(MockWebsocketService);
-    mockWebsocket.emitSubscribeEvent({
+    const websocketMock = spectator.inject(MockWebsocketService);
+    websocketMock.emitSubscribeEvent({
       msg: ApiEventMessage.Added,
       collection: 'alert.list',
       fields: {
@@ -162,8 +162,8 @@ describe('AlertsPanelComponent', () => {
   it('updates an alert when websocket alert.list subscription sends a "change" event', () => {
     spectator.inject(Store).dispatch(adminUiInitialized());
 
-    const mockWebsocket = spectator.inject(MockWebsocketService);
-    mockWebsocket.emitSubscribeEvent({
+    const websocketMock = spectator.inject(MockWebsocketService);
+    websocketMock.emitSubscribeEvent({
       msg: ApiEventMessage.Changed,
       collection: 'alert.list',
       fields: {

src/app/modules/entity/entity-form/entity-form.component.ts

@@ -253,23 +253,23 @@ export class EntityFormComponent implements OnInit, OnDestroy, OnChanges, AfterV
       } else if (this.conf.queryCall) {
         if (this.pk) {
           let pk = this.pk;
-          let filter = [];
+          let filterParam = [];
           if (this.conf.pk) {
-            filter.push(this.conf.pk);
+            filterParam.push(this.conf.pk);
             pk = this.conf.pk;
           }
           if (this.conf.queryCallOption) {
-            filter.push(this.conf.queryCallOption);
+            filterParam.push(this.conf.queryCallOption);
           }
           if (this.conf.customFilter) {
-            filter = this.conf.customFilter;
+            filterParam = this.conf.customFilter;
           }
           if (this.conf.queryKey) {
-            filter = [[[this.conf.queryKey, '=', parseInt(pk as string, 10) || pk]]]; // parse pk to int if possible (returns NaN otherwise)
+            filterParam = [[[this.conf.queryKey, '=', parseInt(pk as string, 10) || pk]]]; // parse pk to int if possible (returns NaN otherwise)
           }
           this.getFunction = this.ws.call(
             this.conf.queryCall,
-            filter as ApiParams<keyof ApiDirectory>,
+            filterParam as ApiParams<keyof ApiDirectory>,
           ) as Observable<Record<string, unknown>>;
         } else {
           this.getFunction = this.ws.call(this.conf.queryCall, []) as Observable<Record<string, unknown>>;

src/app/modules/entity/entity-form/services/field-relation.service.ts

@@ -41,10 +41,10 @@ export class FieldRelationService {
       } else {
         const subControlKeys = Object.keys(controlGroup.controls).filter((key) => key.startsWith(`${rel.name}_`));
         subControlKeys.forEach((key) => {
-          const control = controlGroup.get(key) as UntypedFormControl;
-          if (control
-              && !controls.some((controlElement) => controlElement === control)) {
-            controls.push(control);
+          const subControl = controlGroup.get(key) as UntypedFormControl;
+          if (subControl
+              && !controls.some((controlElement) => controlElement === subControl)) {
+            controls.push(subControl);
           }
         });
       }

src/app/modules/entity/entity-table/entity-table.component.ts

@@ -1069,12 +1069,12 @@ export class EntityTableComponent<Row extends SomeRow = SomeRow> implements OnIn
       cols: this.conf.columns,
     } as unknown as TableDisplayedColumns;
 
-    this.store$.pipe(select(selectPreferencesState), take(1), untilDestroyed(this)).subscribe((state) => {
-      if (!state.areLoaded) {
+    this.store$.pipe(select(selectPreferencesState), take(1), untilDestroyed(this)).subscribe((preferencesState) => {
+      if (!preferencesState.areLoaded) {
         return;
       }
 
-      const existingPreferredColumns = state.preferences.tableDisplayedColumns || [];
+      const existingPreferredColumns = preferencesState.preferences.tableDisplayedColumns || [];
       const preferredColumns = existingPreferredColumns.filter((column) => {
         return column.title !== this.title;
       });
@@ -1124,9 +1124,9 @@ export class EntityTableComponent<Row extends SomeRow = SomeRow> implements OnIn
     // Bring warnings to user's attention even if state is finished or successful.
     if (row.warnings && row.warnings.length > 0) return 'fn-theme-orange';
 
-    const state: JobState = row.state;
+    const jobState = row.state;
 
-    switch (state) {
+    switch (jobState) {
       case JobState.Pending:
       case JobState.Running:
       case JobState.Aborted:

src/app/modules/entity/table/expandable-table/expandable-table.component.html

@@ -65,7 +65,7 @@
   >
     <div>
       <a [routerLink]="tableConf.detailsHref.split('/')">
-        {{ 'View Details' | translate }}
+        {{ 'View All' | translate }}
       </a>
     </div>
   </div>

src/app/modules/ix-drop-grid/ix-drop-grid.directive.spec.ts

@@ -39,7 +39,7 @@ describe('IxDropGridDirective', () => {
     ],
   });
 
-  function setupMocks(spectator: SpectatorDirective<IxDropGridDirective>): void {
+  function setupMocks(): void {
     resolveAndCreateOriginal = ReflectiveInjector.resolveAndCreate;
     ReflectiveInjector.resolveAndCreate = jest.fn().mockReturnValue(fakeInjector);
 
@@ -62,7 +62,7 @@ describe('IxDropGridDirective', () => {
   describe('ngOnInit()', () => {
     beforeEach(() => {
       spectator = createDirective(null, { detectChanges: false });
-      setupMocks(spectator);
+      setupMocks();
     });
 
     afterEach(() => {
@@ -83,7 +83,7 @@ describe('IxDropGridDirective', () => {
   describe('registerPlaceholder()', () => {
     beforeEach(() => {
       spectator = createDirective(null, { detectChanges: false });
-      setupMocks(spectator);
+      setupMocks();
     });
     afterEach(() => {
       restoreMocks();
@@ -98,7 +98,7 @@ describe('IxDropGridDirective', () => {
   describe('registerItem()', () => {
     beforeEach(() => {
       spectator = createDirective(null, { detectChanges: false });
-      setupMocks(spectator);
+      setupMocks();
     });
     afterEach(() => {
       restoreMocks();
@@ -157,7 +157,7 @@ describe('IxDropGridDirective', () => {
 
     beforeEach(() => {
       spectator = createDirective(null, { detectChanges: false });
-      setupMocks(spectator);
+      setupMocks();
 
       const fakeSourceParentElement = {
         removeChild: jest.fn(),
@@ -343,7 +343,7 @@ describe('IxDropGridDirective', () => {
 
     beforeEach(() => {
       spectator = createDirective(null, { detectChanges: false });
-      setupMocks(spectator);
+      setupMocks();
 
       fakeParentElement = {
         appendChild: jest.fn(),

src/app/modules/layout/components/change-password-dialog/change-password-dialog.component.spec.ts

@@ -40,8 +40,8 @@ describe('ChangePasswordDialogComponent', () => {
   });
 
   it('checks current user password and shows an error if it is not correct', async () => {
-    const mockWebsocket = spectator.inject(MockWebsocketService);
-    mockWebsocket.mockCallOnce('auth.check_user', false);
+    const websocketMock = spectator.inject(MockWebsocketService);
+    websocketMock.mockCallOnce('auth.check_user', false);
 
     const form = await loader.getHarness(IxFormHarness);
     await form.fillForm({

src/app/modules/layout/components/topbar/directory-services-indicator/directory-services-indicator.component.spec.ts

@@ -65,8 +65,8 @@ describe('DirectoryServicesIndicatorComponent', () => {
     const icon = spectator.query('button');
     expect(icon).toExist();
 
-    const mockWebsocket = spectator.inject(MockWebsocketService);
-    mockWebsocket.subscribe.mockImplementation(() => of({
+    const websocketMock = spectator.inject(MockWebsocketService);
+    websocketMock.subscribe.mockImplementation(() => of({
       fields: {
         activedirectory: DirectoryServiceState.Disabled,
         ldap: DirectoryServiceState.Disabled,

src/app/pages/account/users/user-details-row/delete-user-dialog/delete-user-dialog.component.spec.ts

@@ -71,8 +71,8 @@ describe('DeleteUserDialogComponent', () => {
   });
 
   it('shows Delete primary group checkbox if this is the last user in the group', async () => {
-    const mockWebsocket = spectator.inject(MockWebsocketService);
-    mockWebsocket.mockCall('group.query', [
+    const websocketMock = spectator.inject(MockWebsocketService);
+    websocketMock.mockCall('group.query', [
       {
         users: [1],
       },

src/app/pages/applications/chart-releases/chart-releases.component.ts

@@ -296,18 +296,18 @@ export class ChartReleasesComponent implements AfterViewInit, OnInit, OnDestroy
           } as ChartUpgradeDialogConfig,
         });
         dialogRef.afterClosed().pipe(filter(Boolean), untilDestroyed(this)).subscribe((version) => {
-          const dialogRef = this.mdDialog.open(EntityJobComponent, {
+          const jobDialogRef = this.mdDialog.open(EntityJobComponent, {
             data: {
               title: helptext.charts.upgrade_dialog.job,
             },
           });
-          dialogRef.componentInstance.setCall('chart.release.upgrade', [name, { item_version: version }]);
-          dialogRef.componentInstance.submit();
-          dialogRef.componentInstance.success.pipe(untilDestroyed(this)).subscribe(() => {
+          jobDialogRef.componentInstance.setCall('chart.release.upgrade', [name, { item_version: version }]);
+          jobDialogRef.componentInstance.submit();
+          jobDialogRef.componentInstance.success.pipe(untilDestroyed(this)).subscribe(() => {
             this.dialogService.closeAllDialogs();
             this.refreshChartReleases();
           });
-          dialogRef.componentInstance.failure.pipe(untilDestroyed(this)).subscribe((error) => {
+          jobDialogRef.componentInstance.failure.pipe(untilDestroyed(this)).subscribe((error) => {
             this.dialogService.closeAllDialogs();
             new EntityUtils().handleWsError(this, error, this.dialogService);
           });

src/app/pages/applications/docker-images/docker-image-delete-dialog/docker-image-delete-dialog.component.ts

@@ -50,13 +50,13 @@ export class DockerImageDeleteDialogComponent {
   onSubmit(): void {
     const { force } = this.form.value;
 
-    const params = this.images.map((image) => [image.id, { force }]);
+    const deleteParams = this.images.map((image) => [image.id, { force }]);
 
     this.images.forEach((image) => {
       this.bulkItems.set(image.id, { state: BulkListItemState.Running, item: image });
     });
 
-    this.ws.job('core.bulk', ['container.image.delete', params]).pipe(
+    this.ws.job('core.bulk', ['container.image.delete', deleteParams]).pipe(
       filter((job: Job<CoreBulkResponse<void>[], DeleteContainerImageParams[]>) => !!job.result),
       untilDestroyed(this),
     ).subscribe((response) => {

src/app/pages/applications/manage-catalogs/manage-catalogs.component.ts

@@ -117,10 +117,10 @@ export class ManageCatalogsComponent implements EntityTableConfig<Catalog>, OnIn
     this.entityList = entityList;
   }
 
-  getActions(row: Catalog): EntityTableAction[] {
+  getActions(catalog: Catalog): EntityTableAction[] {
     return [
       {
-        id: row.id,
+        id: catalog.id,
         icon: 'edit',
         label: helptext.manageCatalogs.menu.edit,
         name: 'edit',
@@ -129,7 +129,7 @@ export class ManageCatalogsComponent implements EntityTableConfig<Catalog>, OnIn
         },
       },
       {
-        id: row.id,
+        id: catalog.id,
         icon: 'refresh',
         label: helptext.manageCatalogs.menu.refresh,
         name: 'refresh',
@@ -138,17 +138,17 @@ export class ManageCatalogsComponent implements EntityTableConfig<Catalog>, OnIn
         },
       },
       {
-        id: row.id,
+        id: catalog.id,
         icon: 'delete',
         label: helptext.manageCatalogs.menu.delete,
         name: 'delete',
-        disabled: row.builtin,
+        disabled: catalog.builtin,
         onClick: (row: Catalog) => {
           this.entityList.doDelete(row);
         },
       },
       {
-        id: row.id,
+        id: catalog.id,
         icon: 'summary',
         label: helptext.manageCatalogs.menu.summary,
         name: 'summary',

src/app/pages/credentials/backup-credentials/cloud-credentials-form/cloud-credentials-form.component.spec.ts

@@ -160,8 +160,8 @@ describe('CloudCredentialsFormComponent', () => {
     });
 
     it('shows an error when verification fails', async () => {
-      const mockWebsocket = spectator.inject(MockWebsocketService);
-      mockWebsocket.mockCall('cloudsync.credentials.verify', {
+      const websocketMock = spectator.inject(MockWebsocketService);
+      websocketMock.mockCall('cloudsync.credentials.verify', {
         valid: false,
         excerpt: 'Missing some important field',
         error: 'Some error',

src/app/pages/credentials/backup-credentials/cloud-credentials-form/provider-forms/one-drive-provider-form/one-drive-provider-form.component.ts

@@ -84,14 +84,14 @@ export class OneDriveProviderFormComponent extends BaseProviderFormComponent imp
 
   private setupDriveSelect(): void {
     this.form.controls.drives.valueChanges.pipe(untilDestroyed(this)).subscribe((driveId) => {
-      const drive = this.drives.find((drive) => drive.drive_id === driveId);
-      if (!drive) {
+      const selectedDrive = this.drives.find((drive) => drive.drive_id === driveId);
+      if (!selectedDrive) {
         return;
       }
 
       this.form.patchValue({
-        drive_type: drive.drive_type,
-        drive_id: drive.drive_id,
+        drive_type: selectedDrive.drive_type,
+        drive_id: selectedDrive.drive_id,
       });
     });
   }

src/app/pages/credentials/certificates-dash/forms/ca-add.component.ts

@@ -630,9 +630,9 @@ export class CertificateAuthorityAddComponent implements WizardConfiguration {
 
   getSummaryValueLabel(fieldConfig: FieldConfig, value: unknown): unknown {
     if (fieldConfig.type === 'select') {
-      const option = fieldConfig.options.find((option) => option.value === value);
-      if (option) {
-        value = option.label;
+      const selectedOption = fieldConfig.options.find((option) => option.value === value);
+      if (selectedOption) {
+        value = selectedOption.label;
       }
     }
 
@@ -642,11 +642,10 @@ export class CertificateAuthorityAddComponent implements WizardConfiguration {
   addToSummary(fieldName: string): void {
     const fieldConfig = this.getTarget(fieldName);
     if (!fieldConfig.isHidden) {
-      const fieldName = fieldConfig.name;
       if (fieldConfig.value !== undefined) {
         this.summary[fieldConfig.placeholder] = this.getSummaryValueLabel(fieldConfig, fieldConfig.value);
       }
-      this.getField(fieldName).valueChanges.pipe(untilDestroyed(this)).subscribe((res) => {
+      this.getField(fieldConfig.name).valueChanges.pipe(untilDestroyed(this)).subscribe((res) => {
         this.summary[fieldConfig.placeholder] = this.getSummaryValueLabel(fieldConfig, res);
       });
     }