chore(utils): resolve no-explicit-any lint suppressions

eslint-suppressions.json

@@ -2008,41 +2008,11 @@
       "count": 1
     }
   },
-  "packages/utils/src/assert.ts": {
-    "@typescript-eslint/no-explicit-any": {
-      "count": 1
-    }
-  },
-  "packages/utils/src/caip-types.test.ts": {
-    "@typescript-eslint/no-explicit-any": {
-      "count": 4
-    }
-  },
-  "packages/utils/src/collections.test.ts": {
-    "@typescript-eslint/no-explicit-any": {
-      "count": 2
-    }
-  },
-  "packages/utils/src/collections.ts": {
-    "@typescript-eslint/no-explicit-any": {
-      "count": 2
-    }
-  },
-  "packages/utils/src/errors.test.ts": {
-    "@typescript-eslint/no-explicit-any": {
-      "count": 3
-    }
-  },
   "packages/utils/src/errors.ts": {
     "no-restricted-syntax": {
       "count": 3
     }
   },
-  "packages/utils/src/fs.test.ts": {
-    "@typescript-eslint/no-explicit-any": {
-      "count": 20
-    }
-  },
   "packages/utils/src/fs.ts": {
     "jsdoc/require-returns": {
       "count": 1
@@ -2058,31 +2028,6 @@
       "count": 3
     }
   },
-  "packages/utils/src/json.ts": {
-    "@typescript-eslint/no-explicit-any": {
-      "count": 1
-    }
-  },
-  "packages/utils/src/json.tst.ts": {
-    "@typescript-eslint/no-explicit-any": {
-      "count": 1
-    }
-  },
-  "packages/utils/src/logging.test.ts": {
-    "@typescript-eslint/no-explicit-any": {
-      "count": 2
-    }
-  },
-  "packages/utils/src/misc.ts": {
-    "@typescript-eslint/no-explicit-any": {
-      "count": 1
-    }
-  },
-  "packages/utils/src/misc.tst.ts": {
-    "@typescript-eslint/no-explicit-any": {
-      "count": 1
-    }
-  },
   "packages/utils/src/mnemonic.ts": {
     "jsdoc/tag-lines": {
       "count": 1
@@ -2092,10 +2037,5 @@
     "jsdoc/tag-lines": {
       "count": 1
     }
-  },
-  "packages/utils/src/unitsConversion.test.ts": {
-    "@typescript-eslint/no-explicit-any": {
-      "count": 29
-    }
   }
 }

packages/utils/CHANGELOG.md

@@ -9,6 +9,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
+- Narrowed three public type signatures from `any` to `unknown` ([#10249](https://github.com/MetaMask/core/pull/10249))
+  - `assert` now accepts `value: unknown`, `FrozenMap.forEach` and `FrozenSet.forEach` now accept `thisArg?: unknown`, and `getKnownPropertyNames` now accepts `Partial<Record<Key, unknown>>`.
+  - This is not a breaking change. `unknown` accepts every value that `any` did, so no call site needs to change.
 - This package was migrated from `MetaMask/utils` to the `MetaMask/core` monorepo ([#10175](https://github.com/MetaMask/core/pull/10175))
   - See [MetaMask/utils](https://github.com/MetaMask/utils/blob/main/CHANGELOG.md) for the original changelog, which covers every release up to and including `12.0.0`.
 

packages/utils/src/assert.ts

@@ -81,7 +81,7 @@ export class AssertionError extends Error {
  * the `message` argument, this argument is ignored.
  */
 export function assert(
-  value: any,
+  value: unknown,
   message: string | Error = 'Assertion failed.',
   ErrorWrapper: AssertionErrorConstructor = AssertionError,
 ): asserts value {

packages/utils/src/caip-types.test.ts

@@ -35,6 +35,12 @@ import {
   toCaipAssetType,
   toCaipChainId,
 } from './caip-types.js';
+import type {
+  CaipAccountId,
+  CaipAssetId,
+  CaipAssetType,
+  CaipChainId,
+} from './caip-types.js';
 
 describe('isCaipChainId', () => {
   it.each(CAIP_CHAIN_ID_FIXTURES)(
@@ -326,7 +332,7 @@ describe('parseCaipChainId', () => {
     'foo:',
     'foo:foobarbazquzfoobarbazquzfoobarbazquzfoobarbazquzfoobarbazquzfoobarbazquz',
   ])('throws for invalid input %s', (input) => {
-    expect(() => parseCaipChainId(input as any)).toThrow(
+    expect(() => parseCaipChainId(input as CaipChainId)).toThrow(
       'Invalid CAIP chain ID.',
     );
   });
@@ -406,7 +412,7 @@ describe('parseCaipAccountId', () => {
     'eip155:1',
     'eip155:1:',
   ])('throws for invalid input %s', (input) => {
-    expect(() => parseCaipAccountId(input as any)).toThrow(
+    expect(() => parseCaipAccountId(input as CaipAccountId)).toThrow(
       'Invalid CAIP account ID.',
     );
   });
@@ -483,7 +489,7 @@ describe('parseCaipAssetType', () => {
     'eip155:1',
     'eip155:1:',
   ])('throws for invalid input %s', (input) => {
-    expect(() => parseCaipAssetType(input as any)).toThrow(
+    expect(() => parseCaipAssetType(input as CaipAssetType)).toThrow(
       'Invalid CAIP asset type.',
     );
   });
@@ -536,7 +542,7 @@ describe('parseCaipAssetId', () => {
     'eip155:1',
     'eip155:1:',
   ])('throws for invalid input %s', (input) => {
-    expect(() => parseCaipAssetId(input as any)).toThrow(
+    expect(() => parseCaipAssetId(input as CaipAssetId)).toThrow(
       'Invalid CAIP asset ID.',
     );
   });

packages/utils/src/collections.test.ts

@@ -21,7 +21,8 @@ describe('FrozenMap', () => {
     });
 
     it('is frozen and cannot be mutated', () => {
-      const frozenMap: any = new FrozenMap();
+      // Cast so the absent mutation methods can be probed for at runtime.
+      const frozenMap = new FrozenMap() as unknown as Record<string, unknown>;
       expect(frozenMap.set).toBeUndefined();
       expect(frozenMap.clear).toBeUndefined();
 
@@ -247,7 +248,8 @@ describe('FrozenSet', () => {
     });
 
     it('is frozen and cannot be mutated', () => {
-      const frozenSet: any = new FrozenSet();
+      // Cast so the absent mutation methods can be probed for at runtime.
+      const frozenSet = new FrozenSet() as unknown as Record<string, unknown>;
       expect(frozenSet.set).toBeUndefined();
       expect(frozenSet.clear).toBeUndefined();
 

packages/utils/src/collections.ts

@@ -33,7 +33,7 @@ class FrozenMap<Key, Value> implements ReadonlyMap<Key, Value> {
 
   public forEach(
     callbackfn: (value: Value, key: Key, map: this) => void,
-    thisArg?: any,
+    thisArg?: unknown,
   ): void {
     // We have to wrap the specified callback in order to prevent it from
     // receiving a reference to the inner map.
@@ -98,7 +98,7 @@ class FrozenSet<Value> implements ReadonlySet<Value> {
 
   public forEach(
     callbackfn: (value: Value, value2: Value, set: this) => void,
-    thisArg?: any,
+    thisArg?: unknown,
   ): void {
     // We have to wrap the specified callback in order to prevent it from
     // receiving a reference to the inner set.

packages/utils/src/errors.test.ts

@@ -129,7 +129,7 @@ describe('wrapError', () => {
       let originalError;
       try {
         await fs.promises.readFile('/tmp/nonexistent', 'utf8');
-      } catch (error: any) {
+      } catch (error) {
         originalError = error;
       }
 
@@ -142,7 +142,7 @@ describe('wrapError', () => {
       let originalError;
       try {
         await fs.promises.readFile('/tmp/nonexistent', 'utf8');
-      } catch (error: any) {
+      } catch (error) {
         originalError = error;
       }
 
@@ -155,7 +155,7 @@ describe('wrapError', () => {
       let originalError;
       try {
         await fs.promises.readFile('/tmp/nonexistent', 'utf8');
-      } catch (error: any) {
+      } catch (error) {
         originalError = error;
       }
 

packages/utils/src/fs.test.ts

@@ -259,15 +259,8 @@ describe('fs', () => {
 
         await withinSandbox(async (sandbox) => {
           const filePath = path.join(sandbox.directoryPath, 'test.json');
-          const stringifier = {
-            stringify(
-              json: any,
-              replacer?:
-                | ((this: any, key: string, value: any) => any)
-                | (number | string)[]
-                | null,
-              space?: string,
-            ): string {
+          const stringifier: { stringify: typeof JSON.stringify } = {
+            stringify(json, replacer, space) {
               return (
                 `${util.inspect(json)}\n` +
                 `replacer: ${util.inspect(replacer)}, space: ${util.inspect(
@@ -290,15 +283,8 @@ describe('fs', () => {
 
         await withinSandbox(async (sandbox) => {
           const filePath = path.join(sandbox.directoryPath, 'test.json');
-          const stringifier = {
-            stringify(
-              json: any,
-              replacer?:
-                | ((this: any, key: string, value: any) => any)
-                | (number | string)[]
-                | null,
-              space?: string,
-            ): string {
+          const stringifier: { stringify: typeof JSON.stringify } = {
+            stringify(json, replacer, space) {
               return (
                 `${util.inspect(json)}\n` +
                 `replacer: ${util.inspect(replacer)}, space: ${util.inspect(
@@ -325,15 +311,8 @@ describe('fs', () => {
 
         await withinSandbox(async (sandbox) => {
           const filePath = path.join(sandbox.directoryPath, 'test.json');
-          const stringifier = {
-            stringify(
-              json: any,
-              replacer?:
-                | ((this: any, key: string, value: any) => any)
-                | (number | string)[]
-                | null,
-              space?: string,
-            ): string {
+          const stringifier: { stringify: typeof JSON.stringify } = {
+            stringify(json, replacer, space) {
               return (
                 `${util.inspect(json)}\n` +
                 `replacer: ${util.inspect(replacer)}, space: ${util.inspect(
@@ -362,15 +341,8 @@ describe('fs', () => {
           // Make sandbox root directory non-readable
           await fs.promises.chmod(sandbox.directoryPath, 0o600);
           const filePath = path.join(sandbox.directoryPath, 'test.json');
-          const stringifier = {
-            stringify(
-              json: any,
-              replacer?:
-                | ((this: any, key: string, value: any) => any)
-                | (number | string)[]
-                | null,
-              space?: string,
-            ): string {
+          const stringifier: { stringify: typeof JSON.stringify } = {
+            stringify(json, replacer, space) {
               return (
                 `${util.inspect(json)}\n` +
                 `replacer: ${util.inspect(replacer)}, space: ${util.inspect(
@@ -435,7 +407,7 @@ describe('fs', () => {
 
     it('re-throws a wrapped version of any error that occurs, assigning it the same code and giving it a stack', async () => {
       const entryPath = '/some/file';
-      const error: any = new Error('oops');
+      const error: Error & { code?: string } = new Error('oops');
       error.code = 'ESOMETHING';
       error.stack = 'some stack';
       when(jest.spyOn(fs.promises, 'stat'))
@@ -494,7 +466,7 @@ describe('fs', () => {
 
     it('re-throws a wrapped version of any error that occurs, assigning it the same code and giving it a stack', async () => {
       const entryPath = '/some/file';
-      const error: any = new Error('oops');
+      const error: Error & { code?: string } = new Error('oops');
       error.code = 'ESOMETHING';
       error.stack = 'some stack';
       when(jest.spyOn(fs.promises, 'stat'))
@@ -604,7 +576,7 @@ describe('fs', () => {
 
       it('re-throws a wrapped version of any error that occurs, assigning it the same code and giving it a stack', async () => {
         const filePath = '/some/file';
-        const error: any = new Error('oops');
+        const error: Error & { code?: string } = new Error('oops');
         error.code = 'ESOMETHING';
         error.stack = 'some stack';
         when(jest.spyOn(fs.promises, 'rm'))
@@ -655,7 +627,7 @@ describe('fs', () => {
 
       it('re-throws a wrapped version of any error that occurs, assigning it the same code and giving it a stack', async () => {
         const directoryPath = '/some/directory';
-        const error: any = new Error('oops');
+        const error: Error & { code?: string } = new Error('oops');
         error.code = 'ESOMETHING';
         error.stack = 'some stack';
         when(jest.spyOn(fs.promises, 'rm'))

packages/utils/src/json.ts

@@ -344,6 +344,7 @@ export const JsonRpcRequestStruct = object({
 });
 
 export type InferWithParams<
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any -- `Struct<any>` is superstruct's idiom for "any struct". `Struct<unknown>` does not work: `Struct` holds `refiner` as a property, which puts the value type in a contravariant position, so no concrete struct satisfies the constraint.
   Type extends Struct<any>,
   Params extends JsonRpcParams,
 > = Infer<Type> & {

packages/utils/src/json.tst.ts

@@ -133,6 +133,7 @@ describe('Json', () => {
   test('has known edge cases', () => {
     // The Json type doesn't protect against the `any` type. Passing `any`
     // explicitly is the point of the test, so it must not be removed.
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any -- The `any` under test cannot be replaced without inverting what this assertion checks.
     expect<any>().type.toBeAssignableTo<Json>();
 
     // The Json type gets confused by interfaces. This interface is valid Json,

packages/utils/src/logging.test.ts

@@ -19,7 +19,7 @@ describe('logging', () => {
       log.enabled = true;
       // Typecast: The Debugger type is wrong and does not include a `useColors`
       // property.
-      (log as any).useColors = false;
+      (log as unknown as { useColors: boolean }).useColors = false;
 
       log('Some message');
 
@@ -38,7 +38,7 @@ describe('logging', () => {
       log.enabled = true;
       // Typecast: The Debugger type is wrong and does not include a `useColors`
       // property.
-      (log as any).useColors = false;
+      (log as unknown as { useColors: boolean }).useColors = false;
 
       log('Some message');
 

packages/utils/src/misc.ts

@@ -120,7 +120,7 @@ export const hasProperty = <
  * derived from the object itself.
  */
 export function getKnownPropertyNames<Key extends PropertyKey>(
-  object: Partial<Record<Key, any>>,
+  object: Partial<Record<Key, unknown>>,
 ): Key[] {
   return Object.getOwnPropertyNames(object) as Key[];
 }

packages/utils/src/misc.tst.ts

@@ -103,7 +103,9 @@ describe('hasProperty', () => {
     exampleErrorWithCode.code = 999;
 
     // Establish that trying to check for a custom property on an error results in failure
-    expect(exampleErrorWithCode).type.not.toBeAssignableTo<{ code: any }>();
+    expect(exampleErrorWithCode).type.not.toBeAssignableTo<{
+      code: unknown;
+    }>();
 
     if (hasProperty(exampleErrorWithCode, 'code')) {
       expect(exampleErrorWithCode.code).type.toBe<unknown>();