Add isEqualCaseInsensitive to controller-utils

MetaMask · Oct 17, 2024 · 644f4d0 · 644f4d0
1 parent 8fb04fc
commit 644f4d0
Show file tree

Hide file tree

Showing 4 changed files with 49 additions and 21 deletions.
diff --git a/packages/assets-controllers/src/TokenDetectionController.ts b/packages/assets-controllers/src/TokenDetectionController.ts
@@ -9,7 +9,11 @@ import type {
   ControllerStateChangeEvent,
 } from '@metamask/base-controller';
 import contractMap from '@metamask/contract-metadata';
-import { ChainId, safelyExecute } from '@metamask/controller-utils';
+import {
+  ChainId,
+  safelyExecute,
+  isEqualCaseInsensitive,
+} from '@metamask/controller-utils';
 import type {
   KeyringControllerGetStateAction,
   KeyringControllerLockEvent,
@@ -44,26 +48,6 @@ import type {
 
 const DEFAULT_INTERVAL = 180000;
 
-/**
- * Compare 2 given strings and return boolean
- * eg: "foo" and "FOO" => true
- * eg: "foo" and "bar" => false
- * eg: "foo" and 123 => false
- *
- * @param value1 - first string to compare
- * @param value2 - first string to compare
- * @returns true if 2 strings are identical when they are lowercase
- */
-export function isEqualCaseInsensitive(
-  value1: string,
-  value2: string,
-): boolean {
-  if (typeof value1 !== 'string' || typeof value2 !== 'string') {
-    return false;
-  }
-  return value1.toLowerCase() === value2.toLowerCase();
-}
-
 type LegacyToken = {
   name: string;
   logo: `${string}.svg`;

diff --git a/packages/controller-utils/src/index.ts b/packages/controller-utils/src/index.ts
@@ -27,6 +27,7 @@ export {
   toChecksumHexAddress,
   toHex,
   weiHexToGweiDec,
+  isEqualCaseInsensitive,
 } from './util';
 export * from './types';
 export * from './siwe';
diff --git a/packages/controller-utils/src/util.test.ts b/packages/controller-utils/src/util.test.ts
@@ -611,3 +611,29 @@ describe('util', () => {
     });
   });
 });
+
+describe('isEqualCaseInsensitive', () => {
+  it('returns false for non-string values', () => {
+    // @ts-expect-error Invalid type for testing purposes
+    expect(util.isEqualCaseInsensitive(null, 'test')).toBe(false);
+    // @ts-expect-error Invalid type for testing purposes
+    expect(util.isEqualCaseInsensitive('test', null)).toBe(false);
+    // @ts-expect-error Invalid type for testing purposes
+    expect(util.isEqualCaseInsensitive(5, 'test')).toBe(false);
+    // @ts-expect-error Invalid type for testing purposes
+    expect(util.isEqualCaseInsensitive('test', 5)).toBe(false);
+  });
+
+  it('returns false for strings that are not equal', () => {
+    expect(util.isEqualCaseInsensitive('test', 'test1')).toBe(false);
+    expect(util.isEqualCaseInsensitive('test1', 'test')).toBe(false);
+  });
+
+  it('returns true for strings that are equal', () => {
+    expect(util.isEqualCaseInsensitive('test', 'TEST')).toBe(true);
+    expect(util.isEqualCaseInsensitive('test', 'test')).toBe(true);
+    expect(util.isEqualCaseInsensitive('TEST', 'TEST')).toBe(true);
+    expect(util.isEqualCaseInsensitive('test', 'Test')).toBe(true);
+    expect(util.isEqualCaseInsensitive('Test', 'test')).toBe(true);
+  });
+});
diff --git a/packages/controller-utils/src/util.ts b/packages/controller-utils/src/util.ts
@@ -619,3 +619,20 @@ function logOrRethrowError(error: unknown, codesToCatch: number[] = []) {
     throw error;
   }
 }
+
+/**
+ * Checks if two strings are equal, ignoring case.
+ *
+ * @param value1 - The first string to compare.
+ * @param value2 - The second string to compare.
+ * @returns `true` if the strings are equal, ignoring case; otherwise, `false`.
+ */
+export function isEqualCaseInsensitive(
+  value1: string,
+  value2: string,
+): boolean {
+  if (typeof value1 !== 'string' || typeof value2 !== 'string') {
+    return false;
+  }
+  return value1.toLowerCase() === value2.toLowerCase();
+}