refactor: fix lint

Author: Prithpal-Sooriya

eslint-warning-thresholds.json

@@ -1,21 +1,21 @@
 {
-  "@typescript-eslint/consistent-type-exports": 19,
+  "@typescript-eslint/consistent-type-exports": 18,
   "@typescript-eslint/no-base-to-string": 3,
   "@typescript-eslint/no-duplicate-enum-values": 2,
   "@typescript-eslint/no-unsafe-enum-comparison": 34,
-  "@typescript-eslint/no-unused-vars": 41,
+  "@typescript-eslint/no-unused-vars": 40,
   "@typescript-eslint/prefer-promise-reject-errors": 33,
-  "@typescript-eslint/prefer-readonly": 147,
+  "@typescript-eslint/prefer-readonly": 137,
   "import-x/namespace": 189,
   "import-x/no-named-as-default": 1,
   "import-x/no-named-as-default-member": 8,
-  "import-x/order": 211,
+  "import-x/order": 208,
   "jest/no-conditional-in-test": 113,
   "jest/prefer-lowercase-title": 2,
   "jest/prefer-strict-equal": 2,
-  "jsdoc/check-tag-names": 375,
+  "jsdoc/check-tag-names": 374,
   "jsdoc/require-returns": 25,
-  "jsdoc/tag-lines": 335,
+  "jsdoc/tag-lines": 334,
   "n/no-unsupported-features/node-builtins": 4,
   "n/prefer-global/text-encoder": 4,
   "n/prefer-global/text-decoder": 4,

packages/notification-services-controller/src/NotificationServicesController/NotificationServicesController.test.ts

@@ -47,7 +47,7 @@ import * as OnChainNotifications from './services/onchain-notifications';
 import type { INotification } from './types';
 import type { UserStorage } from './types/user-storage/user-storage';
 import * as Utils from './utils/utils';
-import { NotificationServicesPushControllerGetStateAction } from '../NotificationServicesPushController';
+import type { NotificationServicesPushControllerGetStateAction } from '../NotificationServicesPushController';
 
 // Mock type used for testing purposes
 // eslint-disable-next-line @typescript-eslint/no-explicit-any

packages/notification-services-controller/src/NotificationServicesController/NotificationServicesController.ts

@@ -307,7 +307,8 @@ export default class NotificationServicesController extends BaseController<
   #isPushNotificationsSetup = false;
 
   #isUnlocked = false;
-  #keyringController = {
+
+  readonly #keyringController = {
     setupLockedStateSubscriptions: (onUnlock: () => Promise<void>) => {
       const { isUnlocked } = this.messagingSystem.call(
         'KeyringController:getState',
@@ -328,7 +329,7 @@ export default class NotificationServicesController extends BaseController<
     },
   };
 
-  #auth = {
+  readonly #auth = {
     getBearerToken: async () => {
       return await this.messagingSystem.call(
         'AuthenticationController:getBearerToken',
@@ -339,7 +340,7 @@ export default class NotificationServicesController extends BaseController<
     },
   };
 
-  #storage = {
+  readonly #storage = {
     enableProfileSyncing: async () => {
       return await this.messagingSystem.call(
         'UserStorageController:enableProfileSyncing',
@@ -363,7 +364,7 @@ export default class NotificationServicesController extends BaseController<
     },
   };
 
-  #pushNotifications = {
+  readonly #pushNotifications = {
     isEnabled: () =>
       this.messagingSystem.call('NotificationServicesPushController:getState')
         ?.isPushEnabled ?? false,
@@ -382,7 +383,6 @@ export default class NotificationServicesController extends BaseController<
             // Push notifications were disabled
             if (prevVal === true && newVal === false) {
               this.#isPushNotificationsSetup = false;
-              return;
             }
           } catch {
             // Do nothing, silently fail push notifications
@@ -473,7 +473,7 @@ export default class NotificationServicesController extends BaseController<
     },
   };
 
-  #accounts = {
+  readonly #accounts = {
     /**
      * Used to get list of addresses from keyring (wallet addresses)
      *
@@ -555,7 +555,7 @@ export default class NotificationServicesController extends BaseController<
     },
   };
 
-  #featureAnnouncementEnv: FeatureAnnouncementEnv;
+  readonly #featureAnnouncementEnv: FeatureAnnouncementEnv;
 
   /**
    * Creates a NotificationServicesController instance.
@@ -565,7 +565,6 @@ export default class NotificationServicesController extends BaseController<
    * @param args.state - Initial state to set on this controller.
    * @param args.env - environment variables for a given controller.
    * @param args.env.featureAnnouncements - env variables for feature announcements.
-   * @param args.env.isPushIntegrated - toggle push notifications on/off if client has integrated them.
    */
   constructor({
     messenger,
@@ -658,14 +657,14 @@ export default class NotificationServicesController extends BaseController<
     return { bearerToken, storageKey };
   }
 
-  #performEnableProfileSyncing = async () => {
+  async #performEnableProfileSyncing() {
     try {
       await this.#storage.enableProfileSyncing();
     } catch (e) {
       log.error('Failed to enable profile syncing', e);
       throw new Error('Failed to enable profile syncing');
     }
-  };
+  }
 
   #assertUserStorage(
     storage: UserStorage | null,

packages/notification-services-controller/src/NotificationServicesPushController/NotificationServicesPushController.ts

@@ -8,14 +8,14 @@ import { BaseController } from '@metamask/base-controller';
 import type { AuthenticationController } from '@metamask/profile-sync-controller';
 import log from 'loglevel';
 
-import type { Types } from '../NotificationServicesController';
 import {
   activatePushNotifications,
   deactivatePushNotifications,
   updateTriggerPushNotifications,
 } from './services/services';
 import type { PushNotificationEnv } from './types';
 import type { PushService } from './types/push-service-interface';
+import type { Types } from '../NotificationServicesController';
 
 const controllerName = 'NotificationServicesPushController';
 
@@ -143,8 +143,6 @@ export type ControllerConfig = {
  * It is responsible for registering and unregistering the service worker that listens for push notifications,
  * managing the FCM token, and communicating with the server to register or unregister the device for push notifications.
  * Additionally, it provides functionality to update the server with new UUIDs that should trigger push notifications.
- *
- * @augments {BaseController<typeof controllerName, NotificationServicesPushControllerState, NotificationServicesPushControllerMessenger>}
  */
 export default class NotificationServicesPushController extends BaseController<
   typeof controllerName,
@@ -153,9 +151,9 @@ export default class NotificationServicesPushController extends BaseController<
 > {
   #pushListenerUnsubscribe: (() => void) | undefined = undefined;
 
-  #env: PushNotificationEnv;
+  readonly #env: PushNotificationEnv;
 
-  #config: ControllerConfig;
+  readonly #config: ControllerConfig;
 
   constructor({
     messenger,
@@ -232,7 +230,7 @@ export default class NotificationServicesPushController extends BaseController<
         (await this.#config.pushService.subscribeToPushNotifications(
           this.#env,
         )) ?? undefined;
-    } catch (e) {
+    } catch {
       // Do nothing, we are silently failing if push notification registration fails
     }
   }
@@ -301,11 +299,9 @@ export default class NotificationServicesPushController extends BaseController<
     }
 
     const bearerToken = await this.#getAndAssertBearerToken();
-    let isPushNotificationsDisabled: boolean;
-
     try {
       // Send a request to the server to unregister the token/device
-      isPushNotificationsDisabled = await deactivatePushNotifications({
+      await deactivatePushNotifications({
         bearerToken,
         triggers: UUIDs,
         env: this.#env,

packages/notification-services-controller/src/NotificationServicesPushController/types/index.ts

@@ -1,2 +1,2 @@
-export * from './firebase';
-export * from './push-service-interface';
+export type * from './firebase';
+export type * from './push-service-interface';

packages/notification-services-controller/src/NotificationServicesPushController/web/push-helpers.ts

@@ -102,13 +102,14 @@ export async function deleteRegToken(
 
     await deleteToken(messaging);
     return true;
-  } catch (error) {
+  } catch {
     return false;
   }
 }
 
 /**
  * Service Worker Listener for when push notifications are received.
+ *
  * @param env - push notification environment
  * @param handler - handler to actually showing notification, MUST BE PROVIDED
  * @returns unsubscribe handler
@@ -178,6 +179,7 @@ function listenToPushNotificationsClicked(
  * 1. Creates subscriptions for receiving and clicking notifications
  * 2. Creates click events when a notification is clicked
  * 3. Publishes controller messenger events
+ *
  * @param props - props for this creator function.
  * @param props.onReceivedHandler - allows the developer to handle showing a notification
  * @param props.onClickHandler - allows the developer to handle clicking the notification