Use proper MetaMask logging

Author: V00D00-child

packages/gator-permissions-controller/src/GatorPermissionContoller.test.ts

@@ -386,7 +386,7 @@ describe('gator-permissions-controller - fetchAndUpdateGatorPermissions() tests'
     });
 
     await expect(controller.fetchAndUpdateGatorPermissions()).rejects.toThrow(
-      'Failed to fetch gator permissions',
+      'Gator permissions are not enabled',
     );
   });
 
@@ -466,7 +466,7 @@ describe('gator-permissions-controller - fetchAndUpdateGatorPermissions() tests'
     await controller.enableGatorPermissions();
 
     await expect(controller.fetchAndUpdateGatorPermissions()).rejects.toThrow(
-      'Failed to fetch gator permissions',
+      'Unsupported permission type: invalid-type',
     );
   });
 
@@ -500,7 +500,7 @@ describe('gator-permissions-controller - fetchAndUpdateGatorPermissions() tests'
     await controller.enableGatorPermissions();
 
     await expect(controller.fetchAndUpdateGatorPermissions()).rejects.toThrow(
-      'Failed to fetch gator permissions',
+      'Invalid permission signer type. Only account signer is supported',
     );
   });
 
@@ -519,7 +519,7 @@ describe('gator-permissions-controller - fetchAndUpdateGatorPermissions() tests'
     await controller.enableGatorPermissions();
 
     await expect(controller.fetchAndUpdateGatorPermissions()).rejects.toThrow(
-      'Failed to fetch gator permissions',
+      'Storage error',
     );
 
     expect(controller.state.isFetchingGatorPermissions).toBe(false);

packages/gator-permissions-controller/src/GatorPermissionsController.ts

@@ -8,7 +8,9 @@ import { BaseController } from '@metamask/base-controller';
 import type { HandleSnapRequest, HasSnap } from '@metamask/snaps-controllers';
 import type { SnapId } from '@metamask/snaps-sdk';
 import { HandlerType } from '@metamask/snaps-utils';
+import { createModuleLogger } from '@metamask/utils';
 
+import { projectLogger } from './logger';
 import type {
   GatorPermissionsList,
   NativeTokenStreamPermission,
@@ -30,6 +32,9 @@ const controllerName = 'GatorPermissionsController';
 const defaultGatorPermissionsProviderSnapId =
   '@metamask/gator-permissions-snap' as SnapId;
 
+// Logger for the controller
+const log = createModuleLogger(projectLogger, 'GatorPermissionsController');
+
 // Enum for the RPC methods of the gator permissions provider snap
 enum GatorPermissionsSnapRpcMethod {
   /**
@@ -428,9 +433,9 @@ export default class GatorPermissionsController extends BaseController<
       });
 
       return gatorPermissionsList;
-    } catch (err) {
-      console.error('Failed to fetch gator permissions', err);
-      throw new Error('Failed to fetch gator permissions');
+    } catch (error) {
+      log('Failed to fetch gator permissions', error);
+      throw error;
     } finally {
       this.#setIsFetchingGatorPermissions(false);
     }

packages/gator-permissions-controller/src/logger.ts

@@ -0,0 +1,9 @@
+/* istanbul ignore file */
+
+import { createProjectLogger, createModuleLogger } from '@metamask/utils';
+
+export const projectLogger = createProjectLogger(
+  'gator-permissions-controller',
+);
+
+export { createModuleLogger };

packages/gator-permissions-controller/src/utils.test.ts

@@ -18,6 +18,23 @@ describe('utils - serializeGatorPermissionsList() tests', () => {
       JSON.stringify(gatorPermissionsList),
     );
   });
+
+  it('throws an error when serialization fails', () => {
+    // Create a valid GatorPermissionsList structure but with circular reference
+    const gatorPermissionsList = {
+      'native-token-stream': {},
+      'native-token-periodic': {},
+      'erc20-token-stream': {},
+    };
+
+    // Add circular reference to cause JSON.stringify to fail
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    (gatorPermissionsList as any).circular = gatorPermissionsList;
+
+    expect(() => {
+      serializeGatorPermissionsList(gatorPermissionsList);
+    }).toThrow('Converting circular structure to JSON');
+  });
 });
 
 describe('utils - deserializeGatorPermissionsList() tests', () => {
@@ -39,4 +56,12 @@ describe('utils - deserializeGatorPermissionsList() tests', () => {
       gatorPermissionsList,
     );
   });
+
+  it('throws an error when deserialization fails', () => {
+    const invalidJson = '{"invalid": json}';
+
+    expect(() => {
+      deserializeGatorPermissionsList(invalidJson);
+    }).toThrow('Unexpected token');
+  });
 });

packages/gator-permissions-controller/src/utils.ts

@@ -1,5 +1,10 @@
+import { createModuleLogger } from '@metamask/utils';
+
+import { projectLogger } from './logger';
 import type { GatorPermissionsList } from './types';
 
+const log = createModuleLogger(projectLogger, 'utils');
+
 /**
  * Serializes a gator permissions list to a string.
  *
@@ -9,7 +14,12 @@ import type { GatorPermissionsList } from './types';
 export function serializeGatorPermissionsList(
   gatorPermissionsList: GatorPermissionsList,
 ): string {
-  return JSON.stringify(gatorPermissionsList);
+  try {
+    return JSON.stringify(gatorPermissionsList);
+  } catch (error) {
+    log('Failed to serialize gator permissions list', error);
+    throw error;
+  }
 }
 
 /**
@@ -21,5 +31,10 @@ export function serializeGatorPermissionsList(
 export function deserializeGatorPermissionsList(
   gatorPermissionsList: string,
 ): GatorPermissionsList {
-  return JSON.parse(gatorPermissionsList);
+  try {
+    return JSON.parse(gatorPermissionsList);
+  } catch (error) {
+    log('Failed to deserialize gator permissions list', error);
+    throw error;
+  }
 }