From 4ee7e3f33faf439e90a6486c308eb6a6bda03b4a Mon Sep 17 00:00:00 2001
From: Prithpal Sooriya <prithpal.sooriya@gmail.com>
Date: Mon, 6 Jan 2025 13:23:30 +0000
Subject: [PATCH] feat: add some authentication state to sentry logs (#29432)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

<!--
Please submit this PR as a draft initially.
Do not mark it as "Ready for review" until the template has been
completely filled out, and PR status checks have passed at least once.
-->

## **Description**

This adds some authentication controller state to sentry logs. We do not
log sensitive and important info such as the `accessToken`.

This should help with logging some of the service failures that rely on
authentication.

<!--
Write a short description of the changes included in this pull request,
also include relevant motivation and context. Have in mind the following
questions:
1. What is the reason for the change?
2. What is the improvement/solution?
-->

[![Open in GitHub
Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/29432?quickstart=1)

## **Related issues**

Fixes: N/A

## **Manual testing steps**

1. Follow the steps in the [development
readme](https://github.com/MetaMask/metamask-extension/blob/main/development/README.md#debugging-sentry)
to invoke a sentry error
- `DEBUG=metamask:sentry:*` and `METAMASK_DEBUG=1` can help to show the
sentry state we are sending.

## **Screenshots/Recordings**

### **Before**

![Screenshot 2025-01-06 at 09 04
48](https://github.com/user-attachments/assets/0469fb5d-9eb3-4616-96f2-e863f2ddcb7c)

### **After**

![Screenshot 2025-01-06 at 11 28
23](https://github.com/user-attachments/assets/b81e6830-bb0f-4276-a345-0a0f7f097fdd)


## **Pre-merge author checklist**

- [x] I've followed [MetaMask Contributor
Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask
Extension Coding
Standards](https://github.com/MetaMask/metamask-extension/blob/main/.github/guidelines/CODING_GUIDELINES.md).
- [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](https://jsdoc.app/) format
if applicable
- [x] I’ve applied the right labels on the PR (see [labeling
guidelines](https://github.com/MetaMask/metamask-extension/blob/main/.github/guidelines/LABELING_GUIDELINES.md)).
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.
---
 app/scripts/constants/sentry-state.ts | 5 +++++
 test/e2e/tests/metrics/errors.spec.js | 7 +++++++
 2 files changed, 12 insertions(+)

diff --git a/app/scripts/constants/sentry-state.ts b/app/scripts/constants/sentry-state.ts
index ab53ffb3f22d..705b33f450ba 100644
--- a/app/scripts/constants/sentry-state.ts
+++ b/app/scripts/constants/sentry-state.ts
@@ -42,6 +42,11 @@ export const SENTRY_BACKGROUND_STATE = {
   },
   AuthenticationController: {
     isSignedIn: false,
+    sessionData: {
+      profile: true,
+      accessToken: false,
+      expiresIn: true,
+    },
   },
   NetworkOrderController: {
     orderedNetworkList: [],
diff --git a/test/e2e/tests/metrics/errors.spec.js b/test/e2e/tests/metrics/errors.spec.js
index 12a44e26fbf1..aaa5c0536485 100644
--- a/test/e2e/tests/metrics/errors.spec.js
+++ b/test/e2e/tests/metrics/errors.spec.js
@@ -904,6 +904,13 @@ describe('Sentry errors', function () {
         // the "resetState" method
         swapsFeatureFlags: true,
       },
+      // Part of the AuthenticationController store, but initialized as undefined
+      // Only populated once the client is authenticated
+      sessionData: {
+        accessToken: false,
+        expiresIn: true,
+        profile: true,
+      },
       // This can get erased due to a bug in the app state controller's
       // preferences state change handler
       timeoutMinutes: true,