Skip to content
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
da93dcc
feat: integrate error tracking service with RPC handlers
mj-kiwi Jan 6, 2026
492d4ab
Merge branch 'main' into feat/error-tracking
mj-kiwi Jan 15, 2026
c5f08dc
fix: correct indentation for i18n initialization in onRpcRequest handler
mj-kiwi Jan 15, 2026
a3f3f56
Merge branch 'main' into feat/error-tracking
mj-kiwi Jan 15, 2026
244595a
feat: integrate error tracking functionality across RPC handlers
mj-kiwi Jan 15, 2026
e97b037
refactor: remove rpcErrorHandler files and clean up package.json exports
mj-kiwi Jan 19, 2026
a3a5fcf
feat: add unit tests for SnapErrorTracker functionality and behavior
mj-kiwi Jan 20, 2026
797c47a
Merge branch 'main' into feat/error-tracking
mj-kiwi Jan 20, 2026
876aa4a
fix: update import statement for ErrorTrackingConfig to use type import
mj-kiwi Jan 20, 2026
0941e99
refactor: update shouldTrackError to use explicit boolean return type…
mj-kiwi Jan 20, 2026
c997296
refactor: enhance error handling in SnapErrorTracker and simplify ins…
mj-kiwi Jan 20, 2026
d4d7517
Merge branch 'main' into feat/error-tracking
mj-kiwi Jan 25, 2026
632e27a
Merge branch 'main' into feat/error-tracking
mj-kiwi Jan 27, 2026
b299440
feat: enhance error tracking by including request parameters in error…
mj-kiwi Jan 27, 2026
a7a9ba7
test: enhance error tracking tests to handle empty error messages
mj-kiwi Jan 28, 2026
1d5c498
Merge branch 'main' into feat/error-tracking
mj-kiwi Jan 28, 2026
8a145a4
Merge branch 'main' into feat/error-tracking
mj-kiwi Jan 28, 2026
3be17e2
fix: improve error tracking logic to handle null and undefined error …
mj-kiwi Jan 28, 2026
372f177
refactor: remove setEnabled and isEnabled methods from SnapErrorTrack…
mj-kiwi Jan 28, 2026
ae6d406
refactor: change #enabled property to readonly in SnapErrorTracker class
mj-kiwi Jan 28, 2026
633037f
fix: reorder processing lock checks in onRpcRequest to improve error …
mj-kiwi Jan 28, 2026
f6e6868
refactor: update error tracking implementation to use snapProvider an…
mj-kiwi Jan 29, 2026
cd4d408
refactor: update error capturing to use structured error objects and …
mj-kiwi Jan 29, 2026
358da1c
test: add case to track string errors with default filter in SnapErro…
mj-kiwi Jan 29, 2026
776130c
refactor: use optional chaining for request properties in error tracking
mj-kiwi Jan 29, 2026
515144a
refactor: replace console.warn with logger.warn for error tracking
mj-kiwi Jan 29, 2026
626edba
refactor: streamline logger warning spy implementation in error track…
mj-kiwi Jan 29, 2026
642ea4f
refactor: update comment to clarify lock token creation in onRpcReque…
mj-kiwi Jan 29, 2026
9fde26f
refactor: enhance error handling to preserve falsy message values for…
mj-kiwi Jan 29, 2026
98f9432
refactor: improve error tracking by releasing lock without awaiting c…
mj-kiwi Jan 29, 2026
e6cc6b0
refactor: enhance error tracking by allowing captureError to handle p…
mj-kiwi Jan 29, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 35 additions & 16 deletions packages/gator-permissions-snap/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
/* eslint-disable no-restricted-globals */
import { logger } from '@metamask/7715-permissions-shared/utils';
import {
logger,
createErrorTracker,
getErrorTracker,
} from '@metamask/7715-permissions-shared/utils';
import {
AuthType,
JwtBearerAuth,
Expand Down Expand Up @@ -190,6 +194,12 @@ const rpcHandler = createRpcHandler({
blockchainMetadataClient: tokenMetadataClient,
});

// Initialize error tracker
createErrorTracker({
enabled: true,
snapName: 'gator-permissions-snap',
});

// configure RPC methods bindings
const boundRpcHandlers: {
[RpcMethod: string]: (params?: JsonRpcParams) => Promise<Json>;
Expand Down Expand Up @@ -221,27 +231,36 @@ export const onRpcRequest: OnRpcRequestHandler = async ({
origin,
request,
}) => {
logger.debug(`RPC request (origin="${origin}"): method="${request.method}"`);

// Ensure i18n is initialized on every snap invocation
// This handles both initial load and locale changes in the extension
await setupI18n();
const errorTracker = getErrorTracker();

if (!isMethodAllowedForOrigin(origin, request.method)) {
throw new InvalidRequestError(
`Origin '${origin}' is not allowed to call '${request.method}'`,
try {
logger.debug(
`RPC request (origin="${origin}"): method="${request.method}"`,
);
}

const handler = boundRpcHandlers[request.method];
// Ensure i18n is initialized on every snap invocation
// This handles both initial load and locale changes in the extension
await setupI18n();

if (!handler) {
throw new MethodNotFoundError(`Method ${request.method} not found.`);
}
if (!isMethodAllowedForOrigin(origin, request.method)) {
throw new InvalidRequestError(
`Origin '${origin}' is not allowed to call '${request.method}'`,
);
}

const handler = boundRpcHandlers[request.method];

const result = await handler(request.params);
if (!handler) {
throw new MethodNotFoundError(`Method ${request.method} not found.`);
}

return result;
const result = await handler(request.params);

return result;
} catch (error) {
await errorTracker.captureError(error, request.method);
throw error;
}
};

/**
Expand Down
67 changes: 67 additions & 0 deletions packages/gator-permissions-snap/src/rpc/rpcErrorHandler.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
/**
* RPC Error Handler Wrapper
*
* This module demonstrates how to integrate the error tracking service
* with RPC request handlers to capture and monitor errors in snap operations.
*/

import { getErrorTracker } from '@metamask/7715-permissions-shared/utils';
import type { Json, JsonRpcParams } from '@metamask/snaps-sdk';

type RpcHandler = (params?: JsonRpcParams) => Promise<Json>;

/**
* Wraps an RPC handler with error tracking.
* Captures any errors that occur during RPC execution while maintaining
* the original error flow.
*
* @param handler - The original RPC handler function.
* @param methodName - The RPC method name (for error tracking).
* @returns A wrapped RPC handler with error tracking.
*/
export function wrapRpcHandlerWithErrorTracking(
handler: RpcHandler,
methodName: string,
): RpcHandler {
return async (params?: JsonRpcParams): Promise<Json> => {
const errorTracker = getErrorTracker();

try {
const result = await handler(params);

// Check if response indicates an error (even with 200 status)
if (
result &&
typeof result === 'object' &&
'error' in result &&
(result as any).error
) {
await errorTracker.captureResponseError(result, methodName);
}

return result;
} catch (error) {
await errorTracker.captureError(error, methodName);
throw error;
}
};
}

/**
* Higher-order function to create multiple wrapped RPC handlers at once.
* Useful for wrapping all RPC handlers in a batch operation.
*
* @param handlers - An object mapping method names to RPC handler functions.
* @returns An object with wrapped handlers.
*/
export function wrapRpcHandlersWithErrorTracking(
handlers: Record<string, RpcHandler>,
): Record<string, RpcHandler> {
const wrapped: Record<string, RpcHandler> = {};

for (const [methodName, handler] of Object.entries(handlers)) {
wrapped[methodName] = wrapRpcHandlerWithErrorTracking(handler, methodName);
}

return wrapped;
}
17 changes: 16 additions & 1 deletion packages/permissions-kernel-snap/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
import { logger } from '@metamask/7715-permissions-shared/utils';
import {
logger,
createErrorTracker,
getErrorTracker,
} from '@metamask/7715-permissions-shared/utils';
import {
InvalidParamsError,
LimitExceededError,
Expand All @@ -19,6 +23,12 @@ const rpcHandler = createRpcHandler({
snapsProvider: snap,
});

// Initialize error tracker
createErrorTracker({
enabled: true,
snapName: 'permissions-kernel-snap',
});

// configure RPC methods bindings
const boundRpcHandlers: {
[RpcMethod: string]: (options: {
Expand Down Expand Up @@ -52,6 +62,8 @@ export const onRpcRequest: OnRpcRequestHandler = async ({
origin,
request,
}) => {
const errorTracker = getErrorTracker();

// Check if another request is already being processed
if (activeProcessingLock !== null) {
logger.warn(
Expand Down Expand Up @@ -101,6 +113,9 @@ export const onRpcRequest: OnRpcRequestHandler = async ({
});

return result;
} catch (error) {
await errorTracker.captureError(error, request.method || 'unknown');
throw error;
} finally {
// Always release the processing lock we acquired, regardless of success or failure
// Only release if we still hold the lock to avoid clobbering a newer lock
Expand Down
72 changes: 72 additions & 0 deletions packages/permissions-kernel-snap/src/rpc/rpcErrorHandler.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
/**
* RPC Error Handler Wrapper
*
* This module demonstrates how to integrate the error tracking service
* with RPC request handlers to capture and monitor errors in snap operations.
*/

import { getErrorTracker } from '@metamask/7715-permissions-shared/utils';
import type { Json, JsonRpcParams } from '@metamask/snaps-sdk';

type RpcHandlerOptions = {
siteOrigin: string;
params?: JsonRpcParams;
};

type RpcHandler = (options: RpcHandlerOptions) => Promise<Json>;

/**
* Wraps an RPC handler with error tracking.
* Captures any errors that occur during RPC execution while maintaining
* the original error flow.
*
* @param handler - The original RPC handler function.
* @param methodName - The RPC method name (for error tracking).
* @returns A wrapped RPC handler with error tracking.
*/
export function wrapRpcHandlerWithErrorTracking(
handler: RpcHandler,
methodName: string,
): RpcHandler {
return async (options: RpcHandlerOptions): Promise<Json> => {
const errorTracker = getErrorTracker();

try {
const result = await handler(options);

// Check if response indicates an error (even with 200 status)
if (
result &&
typeof result === 'object' &&
'error' in result &&
(result as any).error
) {
await errorTracker.captureResponseError(result, methodName);
}

return result;
} catch (error) {
await errorTracker.captureError(error, methodName);
throw error;
}
};
}

/**
* Higher-order function to create multiple wrapped RPC handlers at once.
* Useful for wrapping all RPC handlers in a batch operation.
*
* @param handlers - An object mapping method names to RPC handler functions.
* @returns An object with wrapped handlers.
*/
export function wrapRpcHandlersWithErrorTracking(
handlers: Record<string, RpcHandler>,
): Record<string, RpcHandler> {
const wrapped: Record<string, RpcHandler> = {};

for (const [methodName, handler] of Object.entries(handlers)) {
wrapped[methodName] = wrapRpcHandlerWithErrorTracking(handler, methodName);
}

return wrapped;
}
4 changes: 3 additions & 1 deletion packages/shared/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@
"./utils": "./src/utils/index.ts",
"./types": "./src/types/index.ts",
"./constants": "./src/constants/index.ts",
"./testing": "./src/testing/index.ts"
"./testing": "./src/testing/index.ts",
"./error-tracking": "./src/utils/errorTracking.ts"
},
"main": "./src",
"types": "./src",
Expand All @@ -28,6 +29,7 @@
"test": "jest"
},
"dependencies": {
"@metamask/snaps-sdk": "10.2.0",
"@metamask/utils": "11.4.2",
"dotenv": "17.2.0",
"zod": "3.25.76"
Expand Down
Loading
Loading