feat(vue): Add Pinia plugin (#13841)

Resolves: #13279
Depends on: #13840 
[Sample
Event](https://sentry-sdks.sentry.io/issues/5939879614/?project=5429219&query=is%3Aunresolved%20issue.priority%3A%5Bhigh%2C%20medium%5D&referrer=issue-stream&sort=date&statsPeriod=1h&stream_index=0)

Docs PR: getsentry/sentry-docs#11516
 

Adds a Pinia plugin with a feature set similar to the Redux integration.

- Attaches Pinia state as an attachment to the event (`true` by default)
- Provides `actionTransformer` and `stateTransformer` to the user for
potentially required PII modifications.
- Adds breadcrumbs for Pinia actions
- Assigns Pinia state to event contexts.

dev-packages/e2e-tests/test-applications/vue-3/package.json

@@ -16,6 +16,7 @@
   },
   "dependencies": {
     "@sentry/vue": "latest || *",
+    "pinia": "^2.2.3",
     "vue": "^3.4.15",
     "vue-router": "^4.2.5"
   },

dev-packages/e2e-tests/test-applications/vue-3/src/main.ts

@@ -4,10 +4,13 @@ import { createApp } from 'vue';
 import App from './App.vue';
 import router from './router';
 
+import { createPinia } from 'pinia';
+
 import * as Sentry from '@sentry/vue';
 import { browserTracingIntegration } from '@sentry/vue';
 
 const app = createApp(App);
+const pinia = createPinia();
 
 Sentry.init({
   app,
@@ -22,5 +25,16 @@ Sentry.init({
   trackComponents: ['ComponentMainView', '<ComponentOneView>'],
 });
 
+pinia.use(
+  Sentry.createSentryPiniaPlugin({
+    actionTransformer: action => `Transformed: ${action}`,
+    stateTransformer: state => ({
+      transformed: true,
+      ...state,
+    }),
+  }),
+);
+
+app.use(pinia);
 app.use(router);
 app.mount('#app');

dev-packages/e2e-tests/test-applications/vue-3/src/router/index.ts

@@ -34,6 +34,10 @@ const router = createRouter({
       path: '/components',
       component: () => import('../views/ComponentMainView.vue'),
     },
+    {
+      path: '/cart',
+      component: () => import('../views/CartView.vue'),
+    },
   ],
 });
 

dev-packages/e2e-tests/test-applications/vue-3/src/stores/cart.ts

@@ -0,0 +1,43 @@
+import { acceptHMRUpdate, defineStore } from 'pinia';
+
+export const useCartStore = defineStore({
+  id: 'cart',
+  state: () => ({
+    rawItems: [] as string[],
+  }),
+  getters: {
+    items: (state): Array<{ name: string; amount: number }> =>
+      state.rawItems.reduce(
+        (items, item) => {
+          const existingItem = items.find(it => it.name === item);
+
+          if (!existingItem) {
+            items.push({ name: item, amount: 1 });
+          } else {
+            existingItem.amount++;
+          }
+
+          return items;
+        },
+        [] as Array<{ name: string; amount: number }>,
+      ),
+  },
+  actions: {
+    addItem(name: string) {
+      this.rawItems.push(name);
+    },
+
+    removeItem(name: string) {
+      const i = this.rawItems.lastIndexOf(name);
+      if (i > -1) this.rawItems.splice(i, 1);
+    },
+
+    throwError() {
+      throw new Error('error');
+    },
+  },
+});
+
+if (import.meta.hot) {
+  import.meta.hot.accept(acceptHMRUpdate(useCartStore, import.meta.hot));
+}

dev-packages/e2e-tests/test-applications/vue-3/src/views/CartView.vue

@@ -0,0 +1,88 @@
+<template>
+  <Layout>
+    <div>
+      <div style="margin: 1rem 0;">
+        <PiniaLogo />
+      </div>
+
+      <form @submit.prevent="addItemToCart" data-testid="add-items">
+        <input id="item-input" type="text" v-model="itemName" />
+        <button id="item-add">Add</button>
+        <button id="throw-error" @click="throwError">Throw error</button>
+      </form>
+
+      <form>
+        <ul data-testid="items">
+          <li v-for="item in cart.items" :key="item.name">
+            {{ item.name }} ({{ item.amount }})
+            <button
+              @click="cart.removeItem(item.name)"
+              type="button"
+            >X</button>
+          </li>
+        </ul>
+
+        <button
+          :disabled="!cart.items.length"
+          @click="clearCart"
+          type="button"
+          data-testid="clear"
+        >Clear the cart</button>
+      </form>
+    </div>
+  </Layout>
+</template>
+
+<script lang="ts">
+import { defineComponent, ref } from 'vue'
+import { useCartStore } from '../stores/cart'
+
+
+export default defineComponent({
+  setup() {
+    const cart = useCartStore()
+
+    const itemName = ref('')
+
+    function addItemToCart() {
+      if (!itemName.value) return
+      cart.addItem(itemName.value)
+      itemName.value = ''
+    }
+
+    function throwError() {
+      throw new Error('This is an error')
+    }
+
+    function clearCart() {
+      if (window.confirm('Are you sure you want to clear the cart?')) {
+        cart.rawItems = []
+      }
+    }
+
+    // @ts-ignore
+    window.stores = { cart }
+
+    return {
+      itemName,
+      addItemToCart,
+      cart,
+
+      throwError,
+      clearCart,
+    }
+  },
+})
+</script>
+
+<style scoped>
+img {
+  width: 200px;
+}
+
+button,
+input {
+  margin-right: 0.5rem;
+  margin-bottom: 0.5rem;
+}
+</style>

dev-packages/e2e-tests/test-applications/vue-3/tests/pinia.test.ts

@@ -0,0 +1,35 @@
+import { expect, test } from '@playwright/test';
+import { waitForError } from '@sentry-internal/test-utils';
+
+test('sends pinia action breadcrumbs and state context', async ({ page }) => {
+  await page.goto('/cart');
+
+  await page.locator('#item-input').fill('item');
+  await page.locator('#item-add').click();
+
+  const errorPromise = waitForError('vue-3', async errorEvent => {
+    return errorEvent?.exception?.values?.[0].value === 'This is an error';
+  });
+
+  await page.locator('#throw-error').click();
+
+  const error = await errorPromise;
+
+  expect(error).toBeTruthy();
+  expect(error.breadcrumbs?.length).toBeGreaterThan(0);
+
+  const actionBreadcrumb = error.breadcrumbs?.find(breadcrumb => breadcrumb.category === 'action');
+
+  expect(actionBreadcrumb).toBeDefined();
+  expect(actionBreadcrumb?.message).toBe('Transformed: addItem');
+  expect(actionBreadcrumb?.level).toBe('info');
+
+  const stateContext = error.contexts?.state?.state;
+
+  expect(stateContext).toBeDefined();
+  expect(stateContext?.type).toBe('pinia');
+  expect(stateContext?.value).toEqual({
+    transformed: true,
+    rawItems: ['item'],
+  });
+});

packages/vue/package.json

@@ -45,7 +45,13 @@
     "@sentry/utils": "8.34.0"
   },
   "peerDependencies": {
-    "vue": "2.x || 3.x"
+    "vue": "2.x || 3.x",
+    "pinia": "2.x"
+  },
+  "peerDependenciesMeta": {
+    "pinia": {
+      "optional": true
+    }
   },
   "devDependencies": {
     "vue": "~3.2.41"

packages/vue/src/index.ts

@@ -5,3 +5,4 @@ export { browserTracingIntegration } from './browserTracingIntegration';
 export { attachErrorHandler } from './errorhandler';
 export { createTracingMixins } from './tracing';
 export { vueIntegration } from './integration';
+export { createSentryPiniaPlugin } from './pinia';

packages/vue/src/pinia.ts

@@ -0,0 +1,103 @@
+import { addBreadcrumb, getClient, getCurrentScope, getGlobalScope } from '@sentry/core';
+import { addNonEnumerableProperty } from '@sentry/utils';
+
+// Inline PiniaPlugin type
+type PiniaPlugin = (context: {
+  store: {
+    $id: string;
+    $state: unknown;
+    $onAction: (callback: (context: { name: string; after: (callback: () => void) => void }) => void) => void;
+  };
+}) => void;
+
+type SentryPiniaPluginOptions = {
+  attachPiniaState?: boolean;
+  addBreadcrumbs?: boolean;
+  actionTransformer?: (action: any) => any;
+  stateTransformer?: (state: any) => any;
+};
+
+export const createSentryPiniaPlugin: (options?: SentryPiniaPluginOptions) => PiniaPlugin = (
+  options: SentryPiniaPluginOptions = {
+    attachPiniaState: true,
+    addBreadcrumbs: true,
+    actionTransformer: action => action,
+    stateTransformer: state => state,
+  },
+) => {
+  const plugin: PiniaPlugin = ({ store }) => {
+    options.attachPiniaState !== false &&
+      getGlobalScope().addEventProcessor((event, hint) => {
+        try {
+          // Get current timestamp in hh:mm:ss
+          const timestamp = new Date().toTimeString().split(' ')[0];
+          const filename = `pinia_state_${store.$id}_${timestamp}.json`;
+
+          hint.attachments = [
+            ...(hint.attachments || []),
+            {
+              filename,
+              data: JSON.stringify(store.$state),
+            },
+          ];
+        } catch (_) {
+          // empty
+        }
+
+        return event;
+      });
+
+    store.$onAction(context => {
+      context.after(() => {
+        const transformedActionName = options.actionTransformer
+          ? options.actionTransformer(context.name)
+          : context.name;
+
+        if (
+          typeof transformedActionName !== 'undefined' &&
+          transformedActionName !== null &&
+          options.addBreadcrumbs !== false
+        ) {
+          addBreadcrumb({
+            category: 'action',
+            message: transformedActionName,
+            level: 'info',
+          });
+        }
+
+        /* Set latest state to scope */
+        const transformedState = options.stateTransformer ? options.stateTransformer(store.$state) : store.$state;
+        const scope = getCurrentScope();
+        const currentState = scope.getScopeData().contexts.state;
+
+        if (typeof transformedState !== 'undefined' && transformedState !== null) {
+          const client = getClient();
+          const options = client && client.getOptions();
+          const normalizationDepth = (options && options.normalizeDepth) || 3; // default state normalization depth to 3
+          const piniaStateContext = { type: 'pinia', value: transformedState };
+
+          const newState = {
+            ...(currentState || {}),
+            state: piniaStateContext,
+          };
+
+          addNonEnumerableProperty(
+            newState,
+            '__sentry_override_normalization_depth__',
+            3 + // 3 layers for `state.value.transformedState
+              normalizationDepth, // rest for the actual state
+          );
+
+          scope.setContext('state', newState);
+        } else {
+          scope.setContext('state', {
+            ...(currentState || {}),
+            state: { type: 'pinia', value: 'undefined' },
+          });
+        }
+      });
+    });
+  };
+
+  return plugin;
+};