fix: lint issues

imblue-dabadee · imblue-dabadee · commit ed9a83660e98 · 2025-09-18T16:40:02.000-05:00
diff --git a/eslint-warning-thresholds.json b/eslint-warning-thresholds.json
@@ -300,20 +300,14 @@
     "jsdoc/check-tag-names": 39,
     "jsdoc/tag-lines": 1
   },
-  "packages/phishing-controller/src/PhishingDetector.ts": {
-    "@typescript-eslint/no-unused-vars": 1,
-    "@typescript-eslint/prefer-readonly": 2,
-    "jsdoc/tag-lines": 2
-  },
   "packages/phishing-controller/src/tests/utils.ts": {
     "@typescript-eslint/no-unused-vars": 1
   },
   "packages/phishing-controller/src/utils.test.ts": {
     "import-x/namespace": 5
   },
   "packages/phishing-controller/src/utils.ts": {
-    "@typescript-eslint/no-unsafe-enum-comparison": 1,
-    "@typescript-eslint/no-unused-vars": 1
+    "@typescript-eslint/no-unsafe-enum-comparison": 1
   },
   "packages/polling-controller/src/AbstractPollingController.ts": {
     "@typescript-eslint/prefer-readonly": 1
diff --git a/packages/phishing-controller/src/PathTrie.test.ts b/packages/phishing-controller/src/PathTrie.test.ts
@@ -2,12 +2,12 @@ import {
   deleteFromTrie,
   isTerminalPath,
   insertToTrie,
-  PathTrie,
+  type PathTrie,
 } from './PathTrie';
 
 const emptyPathTrie: PathTrie = {};
 
-describe.only('PathTrie', () => {
+describe('PathTrie', () => {
   describe('insertToTrie', () => {
     let pathTrie: PathTrie;
 
diff --git a/packages/phishing-controller/src/PathTrie.ts b/packages/phishing-controller/src/PathTrie.ts
@@ -6,25 +6,29 @@ export type PathNode = {
 
 export type PathTrie = Record<string, PathNode>;
 
+const isTerminal = (node: PathNode): boolean => {
+  return Object.keys(node).length === 0;
+};
+
 /**
- * Insert a URL into the trie, mutating `pathTrie` in place.
- * - If an ancestor path already exists as a terminal ({}), do nothing.
- * - If inserting an ancestor of existing entries, prune descendants by setting that node to {}.
- * - If no path segments exist (bare host or "/"), do nothing.
+ * Insert a URL into the trie.
+ *
+ * @param url - The URL to insert into the trie.
+ * @param pathTrie - The trie to insert the URL into.
  */
 export const insertToTrie = (url: string, pathTrie: PathTrie) => {
-  var { hostname, pathComponents } = getHostnameAndPathComponents(url);
+  const { hostname, pathComponents } = getHostnameAndPathComponents(url);
 
   if (pathComponents.length === 0 || !hostname) {
     return;
   }
 
-  hostname = hostname.toLowerCase();
-  if (!pathTrie[hostname]) {
-    pathTrie[hostname] = {} as PathNode;
+  const lowerHostname = hostname.toLowerCase();
+  if (!pathTrie[lowerHostname]) {
+    pathTrie[lowerHostname] = {} as PathNode;
   }
 
-  let curr: PathNode = pathTrie[hostname];
+  let curr: PathNode = pathTrie[lowerHostname];
   for (let i = 0; i < pathComponents.length; i++) {
     const pathComponent = pathComponents[i];
     const isLast = i === pathComponents.length - 1;
@@ -56,20 +60,25 @@ export const insertToTrie = (url: string, pathTrie: PathTrie) => {
   }
 };
 
+/**
+ * Delete a URL from the trie.
+ *
+ * @param url - The URL to delete from the trie.
+ * @param pathTrie - The trie to delete the URL from.
+ */
 export const deleteFromTrie = (url: string, pathTrie: PathTrie) => {
-  var { hostname, pathComponents } = getHostnameAndPathComponents(url);
+  const { hostname, pathComponents } = getHostnameAndPathComponents(url);
 
-  if (pathComponents.length === 0 || !pathTrie[hostname]) {
+  const lowerHostname = hostname.toLowerCase();
+  if (pathComponents.length === 0 || !pathTrie[lowerHostname]) {
     return;
   }
 
   const pathToNode: { node: PathNode; key: string }[] = [
-    { node: pathTrie, key: hostname },
+    { node: pathTrie, key: lowerHostname },
   ];
-  let curr: PathNode = pathTrie[hostname];
-  for (let i = 0; i < pathComponents.length; i++) {
-    const pathComponent = pathComponents[i];
-
+  let curr: PathNode = pathTrie[lowerHostname];
+  for (const pathComponent of pathComponents) {
     if (!curr[pathComponent]) {
       return;
     }
@@ -90,25 +99,27 @@ export const deleteFromTrie = (url: string, pathTrie: PathTrie) => {
   }
 };
 
+/**
+ * Check if a URL is a terminal path i.e. the last path component is a terminal node.
+ *
+ * @param url - The URL to check.
+ * @param pathTrie - The trie to check the URL in.
+ * @returns True if the URL is a terminal path, false otherwise.
+ */
 export const isTerminalPath = (url: string, pathTrie: PathTrie): boolean => {
-  var { hostname, pathComponents } = getHostnameAndPathComponents(url);
+  const { hostname, pathComponents } = getHostnameAndPathComponents(url);
 
-  hostname = hostname.toLowerCase();
-  if (pathComponents.length === 0 || !hostname || !pathTrie[hostname]) {
+  const lowerHostname = hostname.toLowerCase();
+  if (pathComponents.length === 0 || !hostname || !pathTrie[lowerHostname]) {
     return false;
   }
 
-  let curr: PathNode = pathTrie[hostname];
-  for (let i = 0; i < pathComponents.length; i++) {
-    const pathComponent = pathComponents[i];
+  let curr: PathNode = pathTrie[lowerHostname];
+  for (const pathComponent of pathComponents) {
     if (!curr[pathComponent]) {
       return false;
     }
     curr = curr[pathComponent];
   }
   return isTerminal(curr);
 };
-
-const isTerminal = (node: PathNode): boolean => {
-  return Object.keys(node).length === 0;
-};
diff --git a/packages/phishing-controller/src/PhishingController.ts b/packages/phishing-controller/src/PhishingController.ts
@@ -11,6 +11,7 @@ import {
 } from '@metamask/controller-utils';
 import { toASCII } from 'punycode/punycode.js';
 
+import { type PathTrie } from './PathTrie';
 import { PhishingDetector } from './PhishingDetector';
 import {
   PhishingDetectorResultType,
@@ -33,7 +34,6 @@ import {
   getPathnameFromUrl,
   separateBlocklistEntries,
 } from './utils';
-import { PathTrie } from './PathTrie';
 
 export const PHISHING_CONFIG_BASE_URL =
   'https://phishing-detection.api.cx.metamask.io';
diff --git a/packages/phishing-controller/src/PhishingDetector.test.ts b/packages/phishing-controller/src/PhishingDetector.test.ts
@@ -1278,7 +1278,7 @@ describe('PhishingDetector', () => {
             expect(result).toBe(true);
             expect(type).toBe(PhishingDetectorResultType.Blocklist);
             expect(name).toBe('test-config');
-            expect(version).toBe(undefined);
+            expect(version).toBeUndefined();
           },
         );
       });
diff --git a/packages/phishing-controller/src/PhishingDetector.ts b/packages/phishing-controller/src/PhishingDetector.ts
@@ -1,5 +1,6 @@
 import { distance } from 'fastest-levenshtein';
 
+import { isTerminalPath, type PathTrie } from './PathTrie';
 import {
   PhishingDetectorResultType,
   type PhishingDetectorResult,
@@ -15,7 +16,6 @@ import {
   processConfigs,
   sha256Hash,
 } from './utils';
-import { isTerminalPath, PathTrie } from './PathTrie';
 
 export type LegacyPhishingDetectorList = {
   whitelist?: string[];
@@ -59,9 +59,9 @@ export type PhishingDetectorConfiguration = {
 };
 
 export class PhishingDetector {
-  #configs: PhishingDetectorConfiguration[];
+  readonly #configs: PhishingDetectorConfiguration[];
 
-  #legacyConfig: boolean;
+  readonly #legacyConfig: boolean;
 
   /**
    * Construct a phishing detector, which can check whether origins are known
@@ -149,7 +149,7 @@ export class PhishingDetector {
     let domain;
     try {
       domain = new URL(url).hostname;
-    } catch (error) {
+    } catch {
       return {
         result: false,
         type: PhishingDetectorResultType.All,
@@ -258,7 +258,6 @@ export class PhishingDetector {
    * Checks if a URL is blocked against the hashed request blocklist.
    * This is done by hashing the URL's hostname and checking it against the hashed request blocklist.
    *
-   *
    * @param urlString - The URL to check.
    * @returns An object indicating if the URL is blocked and relevant metadata.
    */
@@ -328,6 +327,7 @@ export class PhishingDetector {
 
 /**
  * Runs a regex match to determine if a string is a IPFS CID
+ *
  * @returns Regex string for IPFS CID
  */
 function ipfsCidRegex() {
diff --git a/packages/phishing-controller/src/utils.test.ts b/packages/phishing-controller/src/utils.test.ts
@@ -1,12 +1,15 @@
 import * as sinon from 'sinon';
 
-import { ListKeys, ListNames } from './PhishingController';
+import {
+  ListKeys,
+  ListNames,
+  type PhishingListState,
+} from './PhishingController';
 import {
   applyDiffs,
   domainToParts,
   fetchTimeNow,
   generateParentDomains,
-  getDefaultPhishingDetectorConfig,
   getHostnameAndPathComponents,
   getHostnameFromUrl,
   getHostnameFromWebUrl,
@@ -271,7 +274,7 @@ describe('applyDiffs', () => {
     });
 
     describe('adding URLs to blocklistPaths', () => {
-      let listState: any;
+      let listState: PhishingListState;
 
       beforeEach(() => {
         listState = {
@@ -381,7 +384,7 @@ describe('applyDiffs', () => {
     });
 
     describe('removing URLs from blocklistPaths', () => {
-      let listState: any;
+      let listState: PhishingListState;
 
       beforeEach(() => {
         listState = {
diff --git a/packages/phishing-controller/src/utils.ts b/packages/phishing-controller/src/utils.ts
