fix: convert Sentry messages to log

NicolasMassart commented 4 days ago

Description

Convert Logger.message to Logger.log as to provide breadcrumb for next event instead of filling Sentry with events that are hitting our quotas.

Our Logger.message util internally uses Sentry captureMessage and Logger.message util internally uses Sentry addBreadcrumb.

Sentry breadcrumbs vs message

/**
 * Captures a message event and sends it to Sentry.
 *
 * @param exception The exception to capture.
 * @param captureContext Define the level of the message or pass in additional data to attach to the message.
 * @returns the id of the captured message.
 */
export declare function captureMessage(message: string, captureContext?: CaptureContext | Severity | SeverityLevel): string;

/**
 * Records a new breadcrumb which will be attached to future events.
 *
 * Breadcrumbs will be added to subsequent events to provide more context on
 * user's actions prior to an error or crash.
 *
 * @param breadcrumb The breadcrumb to record.
 */
export declare function addBreadcrumb(breadcrumb: Breadcrumb, hint?: BreadcrumbHint): ReturnType<Hub['addBreadcrumb']>;

Improvement suggestion

In order to prevent this Logger.message to be used again I recommend to completely remove it from utils and force the use of either logs or errors. We had only 3 places it was used, as they are now removed, deleting the utility function has no impact.

Related issues

see MetaMask/mobile-planning/issues/1814

Manual testing steps

NA

Screenshots/Recordings

Before

NA

After

NA

Pre-merge author checklist

[X] I’ve followed MetaMask Contributor Docs and MetaMask Mobile Coding Standards.
[x] I've completed the PR template to the best of my ability
[x] I’ve included tests if applicable
[x] I’ve documented my code using JSDoc format if applicable
[x] I’ve applied the right labels on the PR (see labeling guidelines). Not required for external contributors.

Pre-merge reviewer checklist

[ ] I've manually tested the PR (e.g. pull and build branch, run the app, test code being changed).
[ ] I confirm that this PR addresses all acceptance criteria described in the ticket it closes and includes the necessary testing evidence such as recordings and or screenshots.