feat(pinia)!: Include state of all stores in breadcrumb#15312

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
s1gr1d merged 2 commits into from
Feb 5, 2025
Merged

feat(pinia)!: Include state of all stores in breadcrumb #15312

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
142be3c
feat(pinia): Include state of all stores in breadcrumb
s1gr1d Feb 5, 2025
4dd428d
fix nuxt e2e test
s1gr1d Feb 5, 2025
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
2 changes: 1 addition & 1 deletion dev-packages/e2e-tests/test-applications/nuxt-4/sentry.client.config.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@ Sentry.init({
tracesSampleRate: 1.0,
integrations: [
Sentry.piniaIntegration(usePinia(), {
actionTransformer: action => `Transformed: ${action}`,
actionTransformer: action => `${action}.transformed`,
stateTransformer: state => ({
transformed: true,
...state,
Expand Down
6 changes: 3 additions & 3 deletions dev-packages/e2e-tests/test-applications/nuxt-4/tests/pinia.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,10 +18,10 @@ test('sends pinia action breadcrumbs and state context', async ({ page }) => {
expect(error).toBeTruthy();
expect(error.breadcrumbs?.length).toBeGreaterThan(0);

const actionBreadcrumb = error.breadcrumbs?.find(breadcrumb => breadcrumb.category === 'action');
const actionBreadcrumb = error.breadcrumbs?.find(breadcrumb => breadcrumb.category === 'pinia.action');

expect(actionBreadcrumb).toBeDefined();
expect(actionBreadcrumb?.message).toBe('Transformed: addItem');
expect(actionBreadcrumb?.message).toBe('Store: cart | Action: addItem.transformed');
expect(actionBreadcrumb?.level).toBe('info');

const stateContext = error.contexts?.state?.state;
Expand All@@ -30,6 +30,6 @@ test('sends pinia action breadcrumbs and state context', async ({ page }) => {
expect(stateContext?.type).toBe('pinia');
expect(stateContext?.value).toEqual({
transformed: true,
rawItems: ['item'],
cart: { rawItems: ['item'] },
});
});
2 changes: 1 addition & 1 deletion dev-packages/e2e-tests/test-applications/vue-3/src/main.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,7 +31,7 @@ Sentry.init({

pinia.use(
Sentry.createSentryPiniaPlugin({
actionTransformer: action => `Transformed: ${action}`,
actionTransformer: action => `${action}.transformed`,
stateTransformer: state => ({
transformed: true,
...state,
Expand Down
3 changes: 1 addition & 2 deletions dev-packages/e2e-tests/test-applications/vue-3/src/stores/cart.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
import { acceptHMRUpdate, defineStore } from 'pinia';

export const useCartStore = defineStore({
id: 'cart',
export const useCartStore = defineStore('cart', {
state: () => ({
rawItems: [] as string[],
}),
Expand Down
10 changes: 10 additions & 0 deletions dev-packages/e2e-tests/test-applications/vue-3/src/stores/counter.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
import { defineStore } from 'pinia';

export const useCounterStore = defineStore('counter', {
state: () => ({ name: 'Counter Store', count: 0 }),
actions: {
increment() {
this.count++;
},
},
});
61 changes: 28 additions & 33 deletions dev-packages/e2e-tests/test-applications/vue-3/src/views/CartView.vue
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,50 +29,45 @@
data-testid="clear"
>Clear the cart</button>
</form>

<br/>

<div>
<h3>Counter: {{ $counter.count }}</h3>
<button @click="$counter.increment">+</button>
</div>
</div>
</Layout>
</template>

<script lang="ts">
import { defineComponent, ref } from 'vue'
<script setup lang="ts">
import { ref } from 'vue'
import { useCartStore } from '../stores/cart'
import { useCounterStore } from '@/stores/counter';

const cart = useCartStore()
const $counter = useCounterStore()

export default defineComponent({
setup() {
const cart = useCartStore()

const itemName = ref('')

function addItemToCart() {
if (!itemName.value) return
cart.addItem(itemName.value)
itemName.value = ''
}
const itemName = ref('')

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 = []
}
}
function addItemToCart() {
if (!itemName.value) return
cart.addItem(itemName.value)
itemName.value = ''
}

// @ts-ignore
window.stores = { cart }
function throwError() {
throw new Error('This is an error')
}

return {
itemName,
addItemToCart,
cart,
function clearCart() {
if (window.confirm('Are you sure you want to clear the cart?')) {
cart.rawItems = []
}
}

throwError,
clearCart,
}
},
})
// @ts-ignore
window.stores = { cart }
</script>

<style scoped>
Expand Down
75 changes: 72 additions & 3 deletions dev-packages/e2e-tests/test-applications/vue-3/tests/pinia.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,10 +18,10 @@ test('sends pinia action breadcrumbs and state context', async ({ page }) => {
expect(error).toBeTruthy();
expect(error.breadcrumbs?.length).toBeGreaterThan(0);

const actionBreadcrumb = error.breadcrumbs?.find(breadcrumb => breadcrumb.category === 'action');
const actionBreadcrumb = error.breadcrumbs?.find(breadcrumb => breadcrumb.category === 'pinia.action');

expect(actionBreadcrumb).toBeDefined();
expect(actionBreadcrumb?.message).toBe('Transformed: addItem');
expect(actionBreadcrumb?.message).toBe('Store: cart | Action: addItem.transformed');
expect(actionBreadcrumb?.level).toBe('info');

const stateContext = error.contexts?.state?.state;
Expand All@@ -30,6 +30,75 @@ test('sends pinia action breadcrumbs and state context', async ({ page }) => {
expect(stateContext?.type).toBe('pinia');
expect(stateContext?.value).toEqual({
transformed: true,
rawItems: ['item'],
cart: {
rawItems: ['item'],
},
counter: {
count: 0,
name: 'Counter Store',
},
});
});

test('state transformer receives full state object and is stored in state context', async ({ page }) => {
await page.goto('/cart');

await page.locator('#item-input').fill('multiple store test');
await page.locator('#item-add').click();

await page.locator('button:text("+")').click();
await page.locator('button:text("+")').click();
await page.locator('button:text("+")').click();

await page.locator('#item-input').fill('multiple store pinia');
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;

// Verify stateTransformer was called with full state and modified state
const stateContext = error.contexts?.state?.state;

expect(stateContext?.value).toEqual({
transformed: true,
cart: {
rawItems: ['multiple store test', 'multiple store pinia'],
},
counter: {
name: 'Counter Store',
count: 3,
},
});
});

test('different store interaction order maintains full state tracking', async ({ page }) => {
await page.goto('/cart');

await page.locator('button:text("+")').click();

await page.locator('#item-input').fill('order test item');
await page.locator('#item-add').click();

await page.locator('button:text("+")').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;

const stateContext = error.contexts?.state?.state;

expect(stateContext).toBeDefined();

const stateValue = stateContext?.value;
expect(stateValue.cart.rawItems).toEqual(['order test item']);
expect(stateValue.counter.count).toBe(2);
});
2 changes: 2 additions & 0 deletions docs/migration/v8-to-v9.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -357,10 +357,12 @@ All exports and APIs of `@sentry/utils` and `@sentry/types` (except for the ones
```

- The option `logErrors` in the `vueIntegration` has been removed. The Sentry Vue error handler will always propagate the error to a user-defined error handler or re-throw the error (which will log the error without modifying).
- The option `stateTransformer` in `createSentryPiniaPlugin()` now receives the full state from all stores as its parameter. The top-level keys of the state object are the store IDs.

### `@sentry/nuxt`

- The `tracingOptions` option in `Sentry.init()` was removed in favor of passing the `vueIntegration()` to `Sentry.init({ integrations: [...] })` and setting `tracingOptions` there.
- The option `stateTransformer` in the `piniaIntegration` now receives the full state from all stores as its parameter. The top-level keys of the state object are the store IDs.

### `@sentry/vue` and `@sentry/nuxt`

Expand Down
34 changes: 24 additions & 10 deletions packages/vue/src/pinia.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,22 @@
import { addBreadcrumb, addNonEnumerableProperty, getClient, getCurrentScope, getGlobalScope } from '@sentry/core';
import type { Ref } from 'vue';

// Inline PiniaPlugin type
// Inline Pinia types
type StateTree = Record<string | number | symbol, any>;
type PiniaPlugin = (context: {
store: {
$id: string;
$state: unknown;
$onAction: (callback: (context: { name: string; after: (callback: () => void) => void }) => void) => void;
};
pinia: { state: Ref<Record<string, StateTree>> };
}) => void;

type SentryPiniaPluginOptions = {
attachPiniaState?: boolean;
addBreadcrumbs?: boolean;
actionTransformer?: (action: any) => any;
stateTransformer?: (state: any) => any;
actionTransformer?: (action: string) => any;
stateTransformer?: (state: Record<string, unknown>) => any;
};

export const createSentryPiniaPlugin: (options?: SentryPiniaPluginOptions) => PiniaPlugin = (
Expand All@@ -24,19 +27,29 @@ export const createSentryPiniaPlugin: (options?: SentryPiniaPluginOptions) => Pi
stateTransformer: state => state,
},
) => {
const plugin: PiniaPlugin = ({ store }) => {
const plugin: PiniaPlugin = ({ store, pinia }) => {
const getAllStoreStates = (): Record<string, unknown> => {
const states: Record<string, unknown> = {};

Object.keys(pinia.state.value).forEach(storeId => {
states[storeId] = pinia.state.value[storeId];
});

return states;
};

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`;
const filename = `pinia_state_all_stores_${timestamp}.json`;

hint.attachments = [
...(hint.attachments || []),
{
filename,
data: JSON.stringify(store.$state),
data: JSON.stringify(getAllStoreStates()),
},
];
} catch (_) {
Expand All@@ -58,14 +71,15 @@ export const createSentryPiniaPlugin: (options?: SentryPiniaPluginOptions) => Pi
options.addBreadcrumbs !== false
) {
addBreadcrumb({
category: 'action',
message: transformedActionName,
category: 'pinia.action',
message: `Store: ${store.$id} | Action: ${transformedActionName}`,
level: 'info',
});
}

/* Set latest state to scope */
const transformedState = options.stateTransformer ? options.stateTransformer(store.$state) : store.$state;
/* Set latest state of all stores to scope */
const allStates = getAllStoreStates();
const transformedState = options.stateTransformer ? options.stateTransformer(allStates) : allStates;
const scope = getCurrentScope();
const currentState = scope.getScopeData().contexts.state;

Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat(pinia)!: Include state of all stores in breadcrumb#15312

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

s1gr1d
merged 2 commits into

from

Feb 5, 2025
 Merged


feat(pinia)!: Include state of all stores in breadcrumb
#15312
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
142be3c

feat(pinia): Include state of all stores in breadcrumb


s1gr1d Feb 5, 2025
4dd428d

fix nuxt e2e test


s1gr1d Feb 5, 2025

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


2 changes: 1 addition & 1 deletion
dev-packages/e2e-tests/test-applications/nuxt-4/sentry.client.config.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@ Sentry.init({
 tracesSampleRate: 1.0,
 integrations: [
 Sentry.piniaIntegration(usePinia(), {
 actionTransformer: action => `Transformed: ${action}`,
 actionTransformer: action => `${action}.transformed`,
 stateTransformer: state => ({
 transformed: true,
 ...state,
Expand Down

6 changes: 3 additions & 3 deletions
dev-packages/e2e-tests/test-applications/nuxt-4/tests/pinia.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,10 +18,10 @@ test('sends pinia action breadcrumbs and state context', async ({ page }) => {
 expect(error).toBeTruthy();
 expect(error.breadcrumbs?.length).toBeGreaterThan(0);

 const actionBreadcrumb = error.breadcrumbs?.find(breadcrumb => breadcrumb.category === 'action');
 const actionBreadcrumb = error.breadcrumbs?.find(breadcrumb => breadcrumb.category === 'pinia.action');

 expect(actionBreadcrumb).toBeDefined();
 expect(actionBreadcrumb?.message).toBe('Transformed: addItem');
 expect(actionBreadcrumb?.message).toBe('Store: cart | Action: addItem.transformed');
 expect(actionBreadcrumb?.level).toBe('info');

 const stateContext = error.contexts?.state?.state;
Expand All@@ -30,6 +30,6 @@ test('sends pinia action breadcrumbs and state context', async ({ page }) => {
 expect(stateContext?.type).toBe('pinia');
 expect(stateContext?.value).toEqual({
 transformed: true,
 rawItems: ['item'],
cart: { rawItems: ['item'] },
 });
});

2 changes: 1 addition & 1 deletion
dev-packages/e2e-tests/test-applications/vue-3/src/main.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,7 +31,7 @@ Sentry.init({

pinia.use(
 Sentry.createSentryPiniaPlugin({
 actionTransformer: action => `Transformed: ${action}`,
 actionTransformer: action => `${action}.transformed`,
 stateTransformer: state => ({
 transformed: true,
 ...state,
Expand Down

3 changes: 1 addition & 2 deletions
dev-packages/e2e-tests/test-applications/vue-3/src/stores/cart.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
import { acceptHMRUpdate, defineStore } from 'pinia';

export const useCartStore = defineStore({
 id: 'cart',
export const useCartStore = defineStore('cart', {
 state: () => ({
 rawItems: [] as string[],
 }),
Expand Down

10 changes: 10 additions & 0 deletions
dev-packages/e2e-tests/test-applications/vue-3/src/stores/counter.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
import { defineStore } from 'pinia';

export const useCounterStore = defineStore('counter', {
 state: () => ({ name: 'Counter Store', count: 0 }),
 actions: {
 increment() {
 this.count++;
 },
 },
});

61 changes: 28 additions & 33 deletions
dev-packages/e2e-tests/test-applications/vue-3/src/views/CartView.vue

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,50 +29,45 @@
 data-testid="clear"
 >Clear the cart</button>
 </form>

 <br/>

 <div>
 <h3>Counter: {{ $counter.count }}</h3>
 <button @click="$counter.increment">+</button>
 </div>
 </div>
 </Layout>
</template>

<script lang="ts">
import { defineComponent, ref } from 'vue'
<script setup lang="ts">
import { ref } from 'vue'
import { useCartStore } from '../stores/cart'
import { useCounterStore } from '@/stores/counter';

const cart = useCartStore()
const $counter = useCounterStore()

export default defineComponent({
 setup() {
 const cart = useCartStore()

 const itemName = ref('')

 function addItemToCart() {
 if (!itemName.value) return
 cart.addItem(itemName.value)
 itemName.value = ''
 }
const itemName = ref('')

 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 = []
 }
 }
function addItemToCart() {
 if (!itemName.value) return
 cart.addItem(itemName.value)
 itemName.value = ''
}

 // @ts-ignore
 window.stores = { cart }
function throwError() {
 throw new Error('This is an error')
}

 return {
 itemName,
 addItemToCart,
 cart,
function clearCart() {
 if (window.confirm('Are you sure you want to clear the cart?')) {
 cart.rawItems = []
 }
}

 throwError,
 clearCart,
 }
 },
})
// @ts-ignore
window.stores = { cart }
</script>

<style scoped>
Expand Down

75 changes: 72 additions & 3 deletions
dev-packages/e2e-tests/test-applications/vue-3/tests/pinia.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,10 +18,10 @@ test('sends pinia action breadcrumbs and state context', async ({ page }) => {
 expect(error).toBeTruthy();
 expect(error.breadcrumbs?.length).toBeGreaterThan(0);

 const actionBreadcrumb = error.breadcrumbs?.find(breadcrumb => breadcrumb.category === 'action');
 const actionBreadcrumb = error.breadcrumbs?.find(breadcrumb => breadcrumb.category === 'pinia.action');

 expect(actionBreadcrumb).toBeDefined();
 expect(actionBreadcrumb?.message).toBe('Transformed: addItem');
 expect(actionBreadcrumb?.message).toBe('Store: cart | Action: addItem.transformed');
 expect(actionBreadcrumb?.level).toBe('info');

 const stateContext = error.contexts?.state?.state;
Expand All@@ -30,6 +30,75 @@ test('sends pinia action breadcrumbs and state context', async ({ page }) => {
 expect(stateContext?.type).toBe('pinia');
 expect(stateContext?.value).toEqual({
 transformed: true,
 rawItems: ['item'],
 cart: {
 rawItems: ['item'],
 },
 counter: {
 count: 0,
 name: 'Counter Store',
 },
 });
});

test('state transformer receives full state object and is stored in state context', async ({ page }) => {
 await page.goto('/cart');

 await page.locator('#item-input').fill('multiple store test');
 await page.locator('#item-add').click();

 await page.locator('button:text("+")').click();
 await page.locator('button:text("+")').click();
 await page.locator('button:text("+")').click();

 await page.locator('#item-input').fill('multiple store pinia');
 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;

 // Verify stateTransformer was called with full state and modified state
 const stateContext = error.contexts?.state?.state;

 expect(stateContext?.value).toEqual({
 transformed: true,
 cart: {
 rawItems: ['multiple store test', 'multiple store pinia'],
 },
 counter: {
 name: 'Counter Store',
 count: 3,
 },
 });
});

test('different store interaction order maintains full state tracking', async ({ page }) => {
 await page.goto('/cart');

 await page.locator('button:text("+")').click();

 await page.locator('#item-input').fill('order test item');
 await page.locator('#item-add').click();

 await page.locator('button:text("+")').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;

 const stateContext = error.contexts?.state?.state;

 expect(stateContext).toBeDefined();

 const stateValue = stateContext?.value;
 expect(stateValue.cart.rawItems).toEqual(['order test item']);
 expect(stateValue.counter.count).toBe(2);
});

2 changes: 2 additions & 0 deletions
docs/migration/v8-to-v9.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -357,10 +357,12 @@ All exports and APIs of `@sentry/utils` and `@sentry/types` (except for the ones
 ```

- The option `logErrors` in the `vueIntegration` has been removed. The Sentry Vue error handler will always propagate the error to a user-defined error handler or re-throw the error (which will log the error without modifying).
- The option `stateTransformer` in `createSentryPiniaPlugin()` now receives the full state from all stores as its parameter. The top-level keys of the state object are the store IDs.

### `@sentry/nuxt`

- The `tracingOptions` option in `Sentry.init()` was removed in favor of passing the `vueIntegration()` to `Sentry.init({ integrations: [...] })` and setting `tracingOptions` there.
- The option `stateTransformer` in the `piniaIntegration` now receives the full state from all stores as its parameter. The top-level keys of the state object are the store IDs.

### `@sentry/vue` and `@sentry/nuxt`

Expand Down

34 changes: 24 additions & 10 deletions
packages/vue/src/pinia.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,19 +1,22 @@
import { addBreadcrumb, addNonEnumerableProperty, getClient, getCurrentScope, getGlobalScope } from '@sentry/core';
import type { Ref } from 'vue';

// Inline PiniaPlugin type
// Inline Pinia types
type StateTree = Record<string | number | symbol, any>;
type PiniaPlugin = (context: {
 store: {
 $id: string;
 $state: unknown;
 $onAction: (callback: (context: { name: string; after: (callback: () => void) => void }) => void) => void;
 };
 pinia: { state: Ref<Record<string, StateTree>> };
}) => void;

type SentryPiniaPluginOptions = {
 attachPiniaState?: boolean;
 addBreadcrumbs?: boolean;
 actionTransformer?: (action: any) => any;
 stateTransformer?: (state: any) => any;
 actionTransformer?: (action: string) => any;
 stateTransformer?: (state: Record<string, unknown>) => any;
};

export const createSentryPiniaPlugin: (options?: SentryPiniaPluginOptions) => PiniaPlugin = (
Expand All@@ -24,19 +27,29 @@ export const createSentryPiniaPlugin: (options?: SentryPiniaPluginOptions) => Pi
 stateTransformer: state => state,
 },
) => {
 const plugin: PiniaPlugin = ({ store }) => {
 const plugin: PiniaPlugin = ({ store, pinia }) => {
 const getAllStoreStates = (): Record<string, unknown> => {
 const states: Record<string, unknown> = {};

 Object.keys(pinia.state.value).forEach(storeId => {
 states[storeId] = pinia.state.value[storeId];
 });

 return states;
 };

 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`;
 const filename = `pinia_state_all_stores_${timestamp}.json`;

 hint.attachments = [
 ...(hint.attachments || []),
 {
 filename,
 data: JSON.stringify(store.$state),
 data: JSON.stringify(getAllStoreStates()),
 },
 ];
 } catch (_) {
Expand All@@ -58,14 +71,15 @@ export const createSentryPiniaPlugin: (options?: SentryPiniaPluginOptions) => Pi
 options.addBreadcrumbs !== false
 ) {
 addBreadcrumb({
 category: 'action',
 message: transformedActionName,
 category: 'pinia.action',
 message: `Store: ${store.$id} | Action: ${transformedActionName}`,
 level: 'info',
 });
 }

 /* Set latest state to scope */
 const transformedState = options.stateTransformer ? options.stateTransformer(store.$state) : store.$state;
 /* Set latest state of all stores to scope */
 const allStates = getAllStoreStates();
 const transformedState = options.stateTransformer ? options.stateTransformer(allStates) : allStates;
 const scope = getCurrentScope();
 const currentState = scope.getScopeData().contexts.state;

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(pinia)!: Include state of all stores in breadcrumb#15312

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

s1gr1d
merged 2 commits into

from

Feb 5, 2025
 Merged


feat(pinia)!: Include state of all stores in breadcrumb
#15312
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
142be3c

feat(pinia): Include state of all stores in breadcrumb


s1gr1d Feb 5, 2025
4dd428d

fix nuxt e2e test


s1gr1d Feb 5, 2025

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


2 changes: 1 addition & 1 deletion
dev-packages/e2e-tests/test-applications/nuxt-4/sentry.client.config.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@ Sentry.init({
 tracesSampleRate: 1.0,
 integrations: [
 Sentry.piniaIntegration(usePinia(), {
 actionTransformer: action => `Transformed: ${action}`,
 actionTransformer: action => `${action}.transformed`,
 stateTransformer: state => ({
 transformed: true,
 ...state,
Expand Down

6 changes: 3 additions & 3 deletions
dev-packages/e2e-tests/test-applications/nuxt-4/tests/pinia.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,10 +18,10 @@ test('sends pinia action breadcrumbs and state context', async ({ page }) => {
 expect(error).toBeTruthy();
 expect(error.breadcrumbs?.length).toBeGreaterThan(0);

 const actionBreadcrumb = error.breadcrumbs?.find(breadcrumb => breadcrumb.category === 'action');
 const actionBreadcrumb = error.breadcrumbs?.find(breadcrumb => breadcrumb.category === 'pinia.action');

 expect(actionBreadcrumb).toBeDefined();
 expect(actionBreadcrumb?.message).toBe('Transformed: addItem');
 expect(actionBreadcrumb?.message).toBe('Store: cart | Action: addItem.transformed');
 expect(actionBreadcrumb?.level).toBe('info');

 const stateContext = error.contexts?.state?.state;
Expand All@@ -30,6 +30,6 @@ test('sends pinia action breadcrumbs and state context', async ({ page }) => {
 expect(stateContext?.type).toBe('pinia');
 expect(stateContext?.value).toEqual({
 transformed: true,
 rawItems: ['item'],
cart: { rawItems: ['item'] },
 });
});

2 changes: 1 addition & 1 deletion
dev-packages/e2e-tests/test-applications/vue-3/src/main.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,7 +31,7 @@ Sentry.init({

pinia.use(
 Sentry.createSentryPiniaPlugin({
 actionTransformer: action => `Transformed: ${action}`,
 actionTransformer: action => `${action}.transformed`,
 stateTransformer: state => ({
 transformed: true,
 ...state,
Expand Down

3 changes: 1 addition & 2 deletions
dev-packages/e2e-tests/test-applications/vue-3/src/stores/cart.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
import { acceptHMRUpdate, defineStore } from 'pinia';

export const useCartStore = defineStore({
 id: 'cart',
export const useCartStore = defineStore('cart', {
 state: () => ({
 rawItems: [] as string[],
 }),
Expand Down

10 changes: 10 additions & 0 deletions
dev-packages/e2e-tests/test-applications/vue-3/src/stores/counter.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
import { defineStore } from 'pinia';

export const useCounterStore = defineStore('counter', {
 state: () => ({ name: 'Counter Store', count: 0 }),
 actions: {
 increment() {
 this.count++;
 },
 },
});

61 changes: 28 additions & 33 deletions
dev-packages/e2e-tests/test-applications/vue-3/src/views/CartView.vue

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,50 +29,45 @@
 data-testid="clear"
 >Clear the cart</button>
 </form>

 <br/>

 <div>
 <h3>Counter: {{ $counter.count }}</h3>
 <button @click="$counter.increment">+</button>
 </div>
 </div>
 </Layout>
</template>

<script lang="ts">
import { defineComponent, ref } from 'vue'
<script setup lang="ts">
import { ref } from 'vue'
import { useCartStore } from '../stores/cart'
import { useCounterStore } from '@/stores/counter';

const cart = useCartStore()
const $counter = useCounterStore()

export default defineComponent({
 setup() {
 const cart = useCartStore()

 const itemName = ref('')

 function addItemToCart() {
 if (!itemName.value) return
 cart.addItem(itemName.value)
 itemName.value = ''
 }
const itemName = ref('')

 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 = []
 }
 }
function addItemToCart() {
 if (!itemName.value) return
 cart.addItem(itemName.value)
 itemName.value = ''
}

 // @ts-ignore
 window.stores = { cart }
function throwError() {
 throw new Error('This is an error')
}

 return {
 itemName,
 addItemToCart,
 cart,
function clearCart() {
 if (window.confirm('Are you sure you want to clear the cart?')) {
 cart.rawItems = []
 }
}

 throwError,
 clearCart,
 }
 },
})
// @ts-ignore
window.stores = { cart }
</script>

<style scoped>
Expand Down

75 changes: 72 additions & 3 deletions
dev-packages/e2e-tests/test-applications/vue-3/tests/pinia.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,10 +18,10 @@ test('sends pinia action breadcrumbs and state context', async ({ page }) => {
 expect(error).toBeTruthy();
 expect(error.breadcrumbs?.length).toBeGreaterThan(0);

 const actionBreadcrumb = error.breadcrumbs?.find(breadcrumb => breadcrumb.category === 'action');
 const actionBreadcrumb = error.breadcrumbs?.find(breadcrumb => breadcrumb.category === 'pinia.action');

 expect(actionBreadcrumb).toBeDefined();
 expect(actionBreadcrumb?.message).toBe('Transformed: addItem');
 expect(actionBreadcrumb?.message).toBe('Store: cart | Action: addItem.transformed');
 expect(actionBreadcrumb?.level).toBe('info');

 const stateContext = error.contexts?.state?.state;
Expand All@@ -30,6 +30,75 @@ test('sends pinia action breadcrumbs and state context', async ({ page }) => {
 expect(stateContext?.type).toBe('pinia');
 expect(stateContext?.value).toEqual({
 transformed: true,
 rawItems: ['item'],
 cart: {
 rawItems: ['item'],
 },
 counter: {
 count: 0,
 name: 'Counter Store',
 },
 });
});

test('state transformer receives full state object and is stored in state context', async ({ page }) => {
 await page.goto('/cart');

 await page.locator('#item-input').fill('multiple store test');
 await page.locator('#item-add').click();

 await page.locator('button:text("+")').click();
 await page.locator('button:text("+")').click();
 await page.locator('button:text("+")').click();

 await page.locator('#item-input').fill('multiple store pinia');
 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;

 // Verify stateTransformer was called with full state and modified state
 const stateContext = error.contexts?.state?.state;

 expect(stateContext?.value).toEqual({
 transformed: true,
 cart: {
 rawItems: ['multiple store test', 'multiple store pinia'],
 },
 counter: {
 name: 'Counter Store',
 count: 3,
 },
 });
});

test('different store interaction order maintains full state tracking', async ({ page }) => {
 await page.goto('/cart');

 await page.locator('button:text("+")').click();

 await page.locator('#item-input').fill('order test item');
 await page.locator('#item-add').click();

 await page.locator('button:text("+")').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;

 const stateContext = error.contexts?.state?.state;

 expect(stateContext).toBeDefined();

 const stateValue = stateContext?.value;
 expect(stateValue.cart.rawItems).toEqual(['order test item']);
 expect(stateValue.counter.count).toBe(2);
});

2 changes: 2 additions & 0 deletions
docs/migration/v8-to-v9.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -357,10 +357,12 @@ All exports and APIs of `@sentry/utils` and `@sentry/types` (except for the ones
 ```

- The option `logErrors` in the `vueIntegration` has been removed. The Sentry Vue error handler will always propagate the error to a user-defined error handler or re-throw the error (which will log the error without modifying).
- The option `stateTransformer` in `createSentryPiniaPlugin()` now receives the full state from all stores as its parameter. The top-level keys of the state object are the store IDs.

### `@sentry/nuxt`

- The `tracingOptions` option in `Sentry.init()` was removed in favor of passing the `vueIntegration()` to `Sentry.init({ integrations: [...] })` and setting `tracingOptions` there.
- The option `stateTransformer` in the `piniaIntegration` now receives the full state from all stores as its parameter. The top-level keys of the state object are the store IDs.

### `@sentry/vue` and `@sentry/nuxt`

Expand Down

34 changes: 24 additions & 10 deletions
packages/vue/src/pinia.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,19 +1,22 @@
import { addBreadcrumb, addNonEnumerableProperty, getClient, getCurrentScope, getGlobalScope } from '@sentry/core';
import type { Ref } from 'vue';

// Inline PiniaPlugin type
// Inline Pinia types
type StateTree = Record<string | number | symbol, any>;
type PiniaPlugin = (context: {
 store: {
 $id: string;
 $state: unknown;
 $onAction: (callback: (context: { name: string; after: (callback: () => void) => void }) => void) => void;
 };
 pinia: { state: Ref<Record<string, StateTree>> };
}) => void;

type SentryPiniaPluginOptions = {
 attachPiniaState?: boolean;
 addBreadcrumbs?: boolean;
 actionTransformer?: (action: any) => any;
 stateTransformer?: (state: any) => any;
 actionTransformer?: (action: string) => any;
 stateTransformer?: (state: Record<string, unknown>) => any;
};

export const createSentryPiniaPlugin: (options?: SentryPiniaPluginOptions) => PiniaPlugin = (
Expand All@@ -24,19 +27,29 @@ export const createSentryPiniaPlugin: (options?: SentryPiniaPluginOptions) => Pi
 stateTransformer: state => state,
 },
) => {
 const plugin: PiniaPlugin = ({ store }) => {
 const plugin: PiniaPlugin = ({ store, pinia }) => {
 const getAllStoreStates = (): Record<string, unknown> => {
 const states: Record<string, unknown> = {};

 Object.keys(pinia.state.value).forEach(storeId => {
 states[storeId] = pinia.state.value[storeId];
 });

 return states;
 };

 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`;
 const filename = `pinia_state_all_stores_${timestamp}.json`;

 hint.attachments = [
 ...(hint.attachments || []),
 {
 filename,
 data: JSON.stringify(store.$state),
 data: JSON.stringify(getAllStoreStates()),
 },
 ];
 } catch (_) {
Expand All@@ -58,14 +71,15 @@ export const createSentryPiniaPlugin: (options?: SentryPiniaPluginOptions) => Pi
 options.addBreadcrumbs !== false
 ) {
 addBreadcrumb({
 category: 'action',
 message: transformedActionName,
 category: 'pinia.action',
 message: `Store: ${store.$id} | Action: ${transformedActionName}`,
 level: 'info',
 });
 }

 /* Set latest state to scope */
 const transformedState = options.stateTransformer ? options.stateTransformer(store.$state) : store.$state;
 /* Set latest state of all stores to scope */
 const allStates = getAllStoreStates();
 const transformedState = options.stateTransformer ? options.stateTransformer(allStates) : allStates;
 const scope = getCurrentScope();
 const currentState = scope.getScopeData().contexts.state;

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(pinia)!: Include state of all stores in breadcrumb#15312

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

s1gr1d
merged 2 commits into

from

Feb 5, 2025
 Merged


feat(pinia)!: Include state of all stores in breadcrumb
#15312
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
142be3c

feat(pinia): Include state of all stores in breadcrumb


s1gr1d Feb 5, 2025
4dd428d

fix nuxt e2e test


s1gr1d Feb 5, 2025

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


2 changes: 1 addition & 1 deletion
dev-packages/e2e-tests/test-applications/nuxt-4/sentry.client.config.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@ Sentry.init({
 tracesSampleRate: 1.0,
 integrations: [
 Sentry.piniaIntegration(usePinia(), {
 actionTransformer: action => `Transformed: ${action}`,
 actionTransformer: action => `${action}.transformed`,
 stateTransformer: state => ({
 transformed: true,
 ...state,
Expand Down

6 changes: 3 additions & 3 deletions
dev-packages/e2e-tests/test-applications/nuxt-4/tests/pinia.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,10 +18,10 @@ test('sends pinia action breadcrumbs and state context', async ({ page }) => {
 expect(error).toBeTruthy();
 expect(error.breadcrumbs?.length).toBeGreaterThan(0);

 const actionBreadcrumb = error.breadcrumbs?.find(breadcrumb => breadcrumb.category === 'action');
 const actionBreadcrumb = error.breadcrumbs?.find(breadcrumb => breadcrumb.category === 'pinia.action');

 expect(actionBreadcrumb).toBeDefined();
 expect(actionBreadcrumb?.message).toBe('Transformed: addItem');
 expect(actionBreadcrumb?.message).toBe('Store: cart | Action: addItem.transformed');
 expect(actionBreadcrumb?.level).toBe('info');

 const stateContext = error.contexts?.state?.state;
Expand All@@ -30,6 +30,6 @@ test('sends pinia action breadcrumbs and state context', async ({ page }) => {
 expect(stateContext?.type).toBe('pinia');
 expect(stateContext?.value).toEqual({
 transformed: true,
 rawItems: ['item'],
cart: { rawItems: ['item'] },
 });
});

2 changes: 1 addition & 1 deletion
dev-packages/e2e-tests/test-applications/vue-3/src/main.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,7 +31,7 @@ Sentry.init({

pinia.use(
 Sentry.createSentryPiniaPlugin({
 actionTransformer: action => `Transformed: ${action}`,
 actionTransformer: action => `${action}.transformed`,
 stateTransformer: state => ({
 transformed: true,
 ...state,
Expand Down

3 changes: 1 addition & 2 deletions
dev-packages/e2e-tests/test-applications/vue-3/src/stores/cart.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
import { acceptHMRUpdate, defineStore } from 'pinia';

export const useCartStore = defineStore({
 id: 'cart',
export const useCartStore = defineStore('cart', {
 state: () => ({
 rawItems: [] as string[],
 }),
Expand Down

10 changes: 10 additions & 0 deletions
dev-packages/e2e-tests/test-applications/vue-3/src/stores/counter.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
import { defineStore } from 'pinia';

export const useCounterStore = defineStore('counter', {
 state: () => ({ name: 'Counter Store', count: 0 }),
 actions: {
 increment() {
 this.count++;
 },
 },
});

61 changes: 28 additions & 33 deletions
dev-packages/e2e-tests/test-applications/vue-3/src/views/CartView.vue

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,50 +29,45 @@
 data-testid="clear"
 >Clear the cart</button>
 </form>

 <br/>

 <div>
 <h3>Counter: {{ $counter.count }}</h3>
 <button @click="$counter.increment">+</button>
 </div>
 </div>
 </Layout>
</template>

<script lang="ts">
import { defineComponent, ref } from 'vue'
<script setup lang="ts">
import { ref } from 'vue'
import { useCartStore } from '../stores/cart'
import { useCounterStore } from '@/stores/counter';

const cart = useCartStore()
const $counter = useCounterStore()

export default defineComponent({
 setup() {
 const cart = useCartStore()

 const itemName = ref('')

 function addItemToCart() {
 if (!itemName.value) return
 cart.addItem(itemName.value)
 itemName.value = ''
 }
const itemName = ref('')

 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 = []
 }
 }
function addItemToCart() {
 if (!itemName.value) return
 cart.addItem(itemName.value)
 itemName.value = ''
}

 // @ts-ignore
 window.stores = { cart }
function throwError() {
 throw new Error('This is an error')
}

 return {
 itemName,
 addItemToCart,
 cart,
function clearCart() {
 if (window.confirm('Are you sure you want to clear the cart?')) {
 cart.rawItems = []
 }
}

 throwError,
 clearCart,
 }
 },
})
// @ts-ignore
window.stores = { cart }
</script>

<style scoped>
Expand Down

75 changes: 72 additions & 3 deletions
dev-packages/e2e-tests/test-applications/vue-3/tests/pinia.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,10 +18,10 @@ test('sends pinia action breadcrumbs and state context', async ({ page }) => {
 expect(error).toBeTruthy();
 expect(error.breadcrumbs?.length).toBeGreaterThan(0);

 const actionBreadcrumb = error.breadcrumbs?.find(breadcrumb => breadcrumb.category === 'action');
 const actionBreadcrumb = error.breadcrumbs?.find(breadcrumb => breadcrumb.category === 'pinia.action');

 expect(actionBreadcrumb).toBeDefined();
 expect(actionBreadcrumb?.message).toBe('Transformed: addItem');
 expect(actionBreadcrumb?.message).toBe('Store: cart | Action: addItem.transformed');
 expect(actionBreadcrumb?.level).toBe('info');

 const stateContext = error.contexts?.state?.state;
Expand All@@ -30,6 +30,75 @@ test('sends pinia action breadcrumbs and state context', async ({ page }) => {
 expect(stateContext?.type).toBe('pinia');
 expect(stateContext?.value).toEqual({
 transformed: true,
 rawItems: ['item'],
 cart: {
 rawItems: ['item'],
 },
 counter: {
 count: 0,
 name: 'Counter Store',
 },
 });
});

test('state transformer receives full state object and is stored in state context', async ({ page }) => {
 await page.goto('/cart');

 await page.locator('#item-input').fill('multiple store test');
 await page.locator('#item-add').click();

 await page.locator('button:text("+")').click();
 await page.locator('button:text("+")').click();
 await page.locator('button:text("+")').click();

 await page.locator('#item-input').fill('multiple store pinia');
 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;

 // Verify stateTransformer was called with full state and modified state
 const stateContext = error.contexts?.state?.state;

 expect(stateContext?.value).toEqual({
 transformed: true,
 cart: {
 rawItems: ['multiple store test', 'multiple store pinia'],
 },
 counter: {
 name: 'Counter Store',
 count: 3,
 },
 });
});

test('different store interaction order maintains full state tracking', async ({ page }) => {
 await page.goto('/cart');

 await page.locator('button:text("+")').click();

 await page.locator('#item-input').fill('order test item');
 await page.locator('#item-add').click();

 await page.locator('button:text("+")').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;

 const stateContext = error.contexts?.state?.state;

 expect(stateContext).toBeDefined();

 const stateValue = stateContext?.value;
 expect(stateValue.cart.rawItems).toEqual(['order test item']);
 expect(stateValue.counter.count).toBe(2);
});

2 changes: 2 additions & 0 deletions
docs/migration/v8-to-v9.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -357,10 +357,12 @@ All exports and APIs of `@sentry/utils` and `@sentry/types` (except for the ones
 ```

- The option `logErrors` in the `vueIntegration` has been removed. The Sentry Vue error handler will always propagate the error to a user-defined error handler or re-throw the error (which will log the error without modifying).
- The option `stateTransformer` in `createSentryPiniaPlugin()` now receives the full state from all stores as its parameter. The top-level keys of the state object are the store IDs.

### `@sentry/nuxt`

- The `tracingOptions` option in `Sentry.init()` was removed in favor of passing the `vueIntegration()` to `Sentry.init({ integrations: [...] })` and setting `tracingOptions` there.
- The option `stateTransformer` in the `piniaIntegration` now receives the full state from all stores as its parameter. The top-level keys of the state object are the store IDs.

### `@sentry/vue` and `@sentry/nuxt`

Expand Down

34 changes: 24 additions & 10 deletions
packages/vue/src/pinia.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,19 +1,22 @@
import { addBreadcrumb, addNonEnumerableProperty, getClient, getCurrentScope, getGlobalScope } from '@sentry/core';
import type { Ref } from 'vue';

// Inline PiniaPlugin type
// Inline Pinia types
type StateTree = Record<string | number | symbol, any>;
type PiniaPlugin = (context: {
 store: {
 $id: string;
 $state: unknown;
 $onAction: (callback: (context: { name: string; after: (callback: () => void) => void }) => void) => void;
 };
 pinia: { state: Ref<Record<string, StateTree>> };
}) => void;

type SentryPiniaPluginOptions = {
 attachPiniaState?: boolean;
 addBreadcrumbs?: boolean;
 actionTransformer?: (action: any) => any;
 stateTransformer?: (state: any) => any;
 actionTransformer?: (action: string) => any;
 stateTransformer?: (state: Record<string, unknown>) => any;
};

export const createSentryPiniaPlugin: (options?: SentryPiniaPluginOptions) => PiniaPlugin = (
Expand All@@ -24,19 +27,29 @@ export const createSentryPiniaPlugin: (options?: SentryPiniaPluginOptions) => Pi
 stateTransformer: state => state,
 },
) => {
 const plugin: PiniaPlugin = ({ store }) => {
 const plugin: PiniaPlugin = ({ store, pinia }) => {
 const getAllStoreStates = (): Record<string, unknown> => {
 const states: Record<string, unknown> = {};

 Object.keys(pinia.state.value).forEach(storeId => {
 states[storeId] = pinia.state.value[storeId];
 });

 return states;
 };

 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`;
 const filename = `pinia_state_all_stores_${timestamp}.json`;

 hint.attachments = [
 ...(hint.attachments || []),
 {
 filename,
 data: JSON.stringify(store.$state),
 data: JSON.stringify(getAllStoreStates()),
 },
 ];
 } catch (_) {
Expand All@@ -58,14 +71,15 @@ export const createSentryPiniaPlugin: (options?: SentryPiniaPluginOptions) => Pi
 options.addBreadcrumbs !== false
 ) {
 addBreadcrumb({
 category: 'action',
 message: transformedActionName,
 category: 'pinia.action',
 message: `Store: ${store.$id} | Action: ${transformedActionName}`,
 level: 'info',
 });
 }

 /* Set latest state to scope */
 const transformedState = options.stateTransformer ? options.stateTransformer(store.$state) : store.$state;
 /* Set latest state of all stores to scope */
 const allStates = getAllStoreStates();
 const transformedState = options.stateTransformer ? options.stateTransformer(allStates) : allStates;
 const scope = getCurrentScope();
 const currentState = scope.getScopeData().contexts.state;

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
feat(pinia)!: Include state of all stores in breadcrumb#15312

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

s1gr1d
merged 2 commits into

from

Feb 5, 2025
 Merged


feat(pinia)!: Include state of all stores in breadcrumb
#15312
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
142be3c

feat(pinia): Include state of all stores in breadcrumb


s1gr1d Feb 5, 2025
4dd428d

fix nuxt e2e test


s1gr1d Feb 5, 2025

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


2 changes: 1 addition & 1 deletion
dev-packages/e2e-tests/test-applications/nuxt-4/sentry.client.config.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@ Sentry.init({
 tracesSampleRate: 1.0,
 integrations: [
 Sentry.piniaIntegration(usePinia(), {
 actionTransformer: action => `Transformed: ${action}`,
 actionTransformer: action => `${action}.transformed`,
 stateTransformer: state => ({
 transformed: true,
 ...state,
Expand Down

6 changes: 3 additions & 3 deletions
dev-packages/e2e-tests/test-applications/nuxt-4/tests/pinia.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,10 +18,10 @@ test('sends pinia action breadcrumbs and state context', async ({ page }) => {
 expect(error).toBeTruthy();
 expect(error.breadcrumbs?.length).toBeGreaterThan(0);

 const actionBreadcrumb = error.breadcrumbs?.find(breadcrumb => breadcrumb.category === 'action');
 const actionBreadcrumb = error.breadcrumbs?.find(breadcrumb => breadcrumb.category === 'pinia.action');

 expect(actionBreadcrumb).toBeDefined();
 expect(actionBreadcrumb?.message).toBe('Transformed: addItem');
 expect(actionBreadcrumb?.message).toBe('Store: cart | Action: addItem.transformed');
 expect(actionBreadcrumb?.level).toBe('info');

 const stateContext = error.contexts?.state?.state;
Expand All@@ -30,6 +30,6 @@ test('sends pinia action breadcrumbs and state context', async ({ page }) => {
 expect(stateContext?.type).toBe('pinia');
 expect(stateContext?.value).toEqual({
 transformed: true,
 rawItems: ['item'],
cart: { rawItems: ['item'] },
 });
});

2 changes: 1 addition & 1 deletion
dev-packages/e2e-tests/test-applications/vue-3/src/main.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,7 +31,7 @@ Sentry.init({

pinia.use(
 Sentry.createSentryPiniaPlugin({
 actionTransformer: action => `Transformed: ${action}`,
 actionTransformer: action => `${action}.transformed`,
 stateTransformer: state => ({
 transformed: true,
 ...state,
Expand Down

3 changes: 1 addition & 2 deletions
dev-packages/e2e-tests/test-applications/vue-3/src/stores/cart.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
import { acceptHMRUpdate, defineStore } from 'pinia';

export const useCartStore = defineStore({
 id: 'cart',
export const useCartStore = defineStore('cart', {
 state: () => ({
 rawItems: [] as string[],
 }),
Expand Down

10 changes: 10 additions & 0 deletions
dev-packages/e2e-tests/test-applications/vue-3/src/stores/counter.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
import { defineStore } from 'pinia';

export const useCounterStore = defineStore('counter', {
 state: () => ({ name: 'Counter Store', count: 0 }),
 actions: {
 increment() {
 this.count++;
 },
 },
});

61 changes: 28 additions & 33 deletions
dev-packages/e2e-tests/test-applications/vue-3/src/views/CartView.vue

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,50 +29,45 @@
 data-testid="clear"
 >Clear the cart</button>
 </form>

 <br/>

 <div>
 <h3>Counter: {{ $counter.count }}</h3>
 <button @click="$counter.increment">+</button>
 </div>
 </div>
 </Layout>
</template>

<script lang="ts">
import { defineComponent, ref } from 'vue'
<script setup lang="ts">
import { ref } from 'vue'
import { useCartStore } from '../stores/cart'
import { useCounterStore } from '@/stores/counter';

const cart = useCartStore()
const $counter = useCounterStore()

export default defineComponent({
 setup() {
 const cart = useCartStore()

 const itemName = ref('')

 function addItemToCart() {
 if (!itemName.value) return
 cart.addItem(itemName.value)
 itemName.value = ''
 }
const itemName = ref('')

 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 = []
 }
 }
function addItemToCart() {
 if (!itemName.value) return
 cart.addItem(itemName.value)
 itemName.value = ''
}

 // @ts-ignore
 window.stores = { cart }
function throwError() {
 throw new Error('This is an error')
}

 return {
 itemName,
 addItemToCart,
 cart,
function clearCart() {
 if (window.confirm('Are you sure you want to clear the cart?')) {
 cart.rawItems = []
 }
}

 throwError,
 clearCart,
 }
 },
})
// @ts-ignore
window.stores = { cart }
</script>

<style scoped>
Expand Down

75 changes: 72 additions & 3 deletions
dev-packages/e2e-tests/test-applications/vue-3/tests/pinia.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,10 +18,10 @@ test('sends pinia action breadcrumbs and state context', async ({ page }) => {
 expect(error).toBeTruthy();
 expect(error.breadcrumbs?.length).toBeGreaterThan(0);

 const actionBreadcrumb = error.breadcrumbs?.find(breadcrumb => breadcrumb.category === 'action');
 const actionBreadcrumb = error.breadcrumbs?.find(breadcrumb => breadcrumb.category === 'pinia.action');

 expect(actionBreadcrumb).toBeDefined();
 expect(actionBreadcrumb?.message).toBe('Transformed: addItem');
 expect(actionBreadcrumb?.message).toBe('Store: cart | Action: addItem.transformed');
 expect(actionBreadcrumb?.level).toBe('info');

 const stateContext = error.contexts?.state?.state;
Expand All@@ -30,6 +30,75 @@ test('sends pinia action breadcrumbs and state context', async ({ page }) => {
 expect(stateContext?.type).toBe('pinia');
 expect(stateContext?.value).toEqual({
 transformed: true,
 rawItems: ['item'],
 cart: {
 rawItems: ['item'],
 },
 counter: {
 count: 0,
 name: 'Counter Store',
 },
 });
});

test('state transformer receives full state object and is stored in state context', async ({ page }) => {
 await page.goto('/cart');

 await page.locator('#item-input').fill('multiple store test');
 await page.locator('#item-add').click();

 await page.locator('button:text("+")').click();
 await page.locator('button:text("+")').click();
 await page.locator('button:text("+")').click();

 await page.locator('#item-input').fill('multiple store pinia');
 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;

 // Verify stateTransformer was called with full state and modified state
 const stateContext = error.contexts?.state?.state;

 expect(stateContext?.value).toEqual({
 transformed: true,
 cart: {
 rawItems: ['multiple store test', 'multiple store pinia'],
 },
 counter: {
 name: 'Counter Store',
 count: 3,
 },
 });
});

test('different store interaction order maintains full state tracking', async ({ page }) => {
 await page.goto('/cart');

 await page.locator('button:text("+")').click();

 await page.locator('#item-input').fill('order test item');
 await page.locator('#item-add').click();

 await page.locator('button:text("+")').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;

 const stateContext = error.contexts?.state?.state;

 expect(stateContext).toBeDefined();

 const stateValue = stateContext?.value;
 expect(stateValue.cart.rawItems).toEqual(['order test item']);
 expect(stateValue.counter.count).toBe(2);
});

2 changes: 2 additions & 0 deletions
docs/migration/v8-to-v9.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -357,10 +357,12 @@ All exports and APIs of `@sentry/utils` and `@sentry/types` (except for the ones
 ```

- The option `logErrors` in the `vueIntegration` has been removed. The Sentry Vue error handler will always propagate the error to a user-defined error handler or re-throw the error (which will log the error without modifying).
- The option `stateTransformer` in `createSentryPiniaPlugin()` now receives the full state from all stores as its parameter. The top-level keys of the state object are the store IDs.

### `@sentry/nuxt`

- The `tracingOptions` option in `Sentry.init()` was removed in favor of passing the `vueIntegration()` to `Sentry.init({ integrations: [...] })` and setting `tracingOptions` there.
- The option `stateTransformer` in the `piniaIntegration` now receives the full state from all stores as its parameter. The top-level keys of the state object are the store IDs.

### `@sentry/vue` and `@sentry/nuxt`

Expand Down

34 changes: 24 additions & 10 deletions
packages/vue/src/pinia.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,19 +1,22 @@
import { addBreadcrumb, addNonEnumerableProperty, getClient, getCurrentScope, getGlobalScope } from '@sentry/core';
import type { Ref } from 'vue';

// Inline PiniaPlugin type
// Inline Pinia types
type StateTree = Record<string | number | symbol, any>;
type PiniaPlugin = (context: {
 store: {
 $id: string;
 $state: unknown;
 $onAction: (callback: (context: { name: string; after: (callback: () => void) => void }) => void) => void;
 };
 pinia: { state: Ref<Record<string, StateTree>> };
}) => void;

type SentryPiniaPluginOptions = {
 attachPiniaState?: boolean;
 addBreadcrumbs?: boolean;
 actionTransformer?: (action: any) => any;
 stateTransformer?: (state: any) => any;
 actionTransformer?: (action: string) => any;
 stateTransformer?: (state: Record<string, unknown>) => any;
};

export const createSentryPiniaPlugin: (options?: SentryPiniaPluginOptions) => PiniaPlugin = (
Expand All@@ -24,19 +27,29 @@ export const createSentryPiniaPlugin: (options?: SentryPiniaPluginOptions) => Pi
 stateTransformer: state => state,
 },
) => {
 const plugin: PiniaPlugin = ({ store }) => {
 const plugin: PiniaPlugin = ({ store, pinia }) => {
 const getAllStoreStates = (): Record<string, unknown> => {
 const states: Record<string, unknown> = {};

 Object.keys(pinia.state.value).forEach(storeId => {
 states[storeId] = pinia.state.value[storeId];
 });

 return states;
 };

 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`;
 const filename = `pinia_state_all_stores_${timestamp}.json`;

 hint.attachments = [
 ...(hint.attachments || []),
 {
 filename,
 data: JSON.stringify(store.$state),
 data: JSON.stringify(getAllStoreStates()),
 },
 ];
 } catch (_) {
Expand All@@ -58,14 +71,15 @@ export const createSentryPiniaPlugin: (options?: SentryPiniaPluginOptions) => Pi
 options.addBreadcrumbs !== false
 ) {
 addBreadcrumb({
 category: 'action',
 message: transformedActionName,
 category: 'pinia.action',
 message: `Store: ${store.$id} | Action: ${transformedActionName}`,
 level: 'info',
 });
 }

 /* Set latest state to scope */
 const transformedState = options.stateTransformer ? options.stateTransformer(store.$state) : store.$state;
 /* Set latest state of all stores to scope */
 const allStates = getAllStoreStates();
 const transformedState = options.stateTransformer ? options.stateTransformer(allStates) : allStates;
 const scope = getCurrentScope();
 const currentState = scope.getScopeData().contexts.state;

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(pinia)!: Include state of all stores in breadcrumb#15312

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

s1gr1d
merged 2 commits into

from

Feb 5, 2025
 Merged


feat(pinia)!: Include state of all stores in breadcrumb
#15312
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
142be3c

feat(pinia): Include state of all stores in breadcrumb


s1gr1d Feb 5, 2025
4dd428d

fix nuxt e2e test


s1gr1d Feb 5, 2025

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


2 changes: 1 addition & 1 deletion
dev-packages/e2e-tests/test-applications/nuxt-4/sentry.client.config.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@ Sentry.init({
 tracesSampleRate: 1.0,
 integrations: [
 Sentry.piniaIntegration(usePinia(), {
 actionTransformer: action => `Transformed: ${action}`,
 actionTransformer: action => `${action}.transformed`,
 stateTransformer: state => ({
 transformed: true,
 ...state,
Expand Down

6 changes: 3 additions & 3 deletions
dev-packages/e2e-tests/test-applications/nuxt-4/tests/pinia.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,10 +18,10 @@ test('sends pinia action breadcrumbs and state context', async ({ page }) => {
 expect(error).toBeTruthy();
 expect(error.breadcrumbs?.length).toBeGreaterThan(0);

 const actionBreadcrumb = error.breadcrumbs?.find(breadcrumb => breadcrumb.category === 'action');
 const actionBreadcrumb = error.breadcrumbs?.find(breadcrumb => breadcrumb.category === 'pinia.action');

 expect(actionBreadcrumb).toBeDefined();
 expect(actionBreadcrumb?.message).toBe('Transformed: addItem');
 expect(actionBreadcrumb?.message).toBe('Store: cart | Action: addItem.transformed');
 expect(actionBreadcrumb?.level).toBe('info');

 const stateContext = error.contexts?.state?.state;
Expand All@@ -30,6 +30,6 @@ test('sends pinia action breadcrumbs and state context', async ({ page }) => {
 expect(stateContext?.type).toBe('pinia');
 expect(stateContext?.value).toEqual({
 transformed: true,
 rawItems: ['item'],
cart: { rawItems: ['item'] },
 });
});

2 changes: 1 addition & 1 deletion
dev-packages/e2e-tests/test-applications/vue-3/src/main.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,7 +31,7 @@ Sentry.init({

pinia.use(
 Sentry.createSentryPiniaPlugin({
 actionTransformer: action => `Transformed: ${action}`,
 actionTransformer: action => `${action}.transformed`,
 stateTransformer: state => ({
 transformed: true,
 ...state,
Expand Down

3 changes: 1 addition & 2 deletions
dev-packages/e2e-tests/test-applications/vue-3/src/stores/cart.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
import { acceptHMRUpdate, defineStore } from 'pinia';

export const useCartStore = defineStore({
 id: 'cart',
export const useCartStore = defineStore('cart', {
 state: () => ({
 rawItems: [] as string[],
 }),
Expand Down

10 changes: 10 additions & 0 deletions
dev-packages/e2e-tests/test-applications/vue-3/src/stores/counter.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
import { defineStore } from 'pinia';

export const useCounterStore = defineStore('counter', {
 state: () => ({ name: 'Counter Store', count: 0 }),
 actions: {
 increment() {
 this.count++;
 },
 },
});

61 changes: 28 additions & 33 deletions
dev-packages/e2e-tests/test-applications/vue-3/src/views/CartView.vue

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,50 +29,45 @@
 data-testid="clear"
 >Clear the cart</button>
 </form>

 <br/>

 <div>
 <h3>Counter: {{ $counter.count }}</h3>
 <button @click="$counter.increment">+</button>
 </div>
 </div>
 </Layout>
</template>

<script lang="ts">
import { defineComponent, ref } from 'vue'
<script setup lang="ts">
import { ref } from 'vue'
import { useCartStore } from '../stores/cart'
import { useCounterStore } from '@/stores/counter';

const cart = useCartStore()
const $counter = useCounterStore()

export default defineComponent({
 setup() {
 const cart = useCartStore()

 const itemName = ref('')

 function addItemToCart() {
 if (!itemName.value) return
 cart.addItem(itemName.value)
 itemName.value = ''
 }
const itemName = ref('')

 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 = []
 }
 }
function addItemToCart() {
 if (!itemName.value) return
 cart.addItem(itemName.value)
 itemName.value = ''
}

 // @ts-ignore
 window.stores = { cart }
function throwError() {
 throw new Error('This is an error')
}

 return {
 itemName,
 addItemToCart,
 cart,
function clearCart() {
 if (window.confirm('Are you sure you want to clear the cart?')) {
 cart.rawItems = []
 }
}

 throwError,
 clearCart,
 }
 },
})
// @ts-ignore
window.stores = { cart }
</script>

<style scoped>
Expand Down

75 changes: 72 additions & 3 deletions
dev-packages/e2e-tests/test-applications/vue-3/tests/pinia.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,10 +18,10 @@ test('sends pinia action breadcrumbs and state context', async ({ page }) => {
 expect(error).toBeTruthy();
 expect(error.breadcrumbs?.length).toBeGreaterThan(0);

 const actionBreadcrumb = error.breadcrumbs?.find(breadcrumb => breadcrumb.category === 'action');
 const actionBreadcrumb = error.breadcrumbs?.find(breadcrumb => breadcrumb.category === 'pinia.action');

 expect(actionBreadcrumb).toBeDefined();
 expect(actionBreadcrumb?.message).toBe('Transformed: addItem');
 expect(actionBreadcrumb?.message).toBe('Store: cart | Action: addItem.transformed');
 expect(actionBreadcrumb?.level).toBe('info');

 const stateContext = error.contexts?.state?.state;
Expand All@@ -30,6 +30,75 @@ test('sends pinia action breadcrumbs and state context', async ({ page }) => {
 expect(stateContext?.type).toBe('pinia');
 expect(stateContext?.value).toEqual({
 transformed: true,
 rawItems: ['item'],
 cart: {
 rawItems: ['item'],
 },
 counter: {
 count: 0,
 name: 'Counter Store',
 },
 });
});

test('state transformer receives full state object and is stored in state context', async ({ page }) => {
 await page.goto('/cart');

 await page.locator('#item-input').fill('multiple store test');
 await page.locator('#item-add').click();

 await page.locator('button:text("+")').click();
 await page.locator('button:text("+")').click();
 await page.locator('button:text("+")').click();

 await page.locator('#item-input').fill('multiple store pinia');
 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;

 // Verify stateTransformer was called with full state and modified state
 const stateContext = error.contexts?.state?.state;

 expect(stateContext?.value).toEqual({
 transformed: true,
 cart: {
 rawItems: ['multiple store test', 'multiple store pinia'],
 },
 counter: {
 name: 'Counter Store',
 count: 3,
 },
 });
});

test('different store interaction order maintains full state tracking', async ({ page }) => {
 await page.goto('/cart');

 await page.locator('button:text("+")').click();

 await page.locator('#item-input').fill('order test item');
 await page.locator('#item-add').click();

 await page.locator('button:text("+")').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;

 const stateContext = error.contexts?.state?.state;

 expect(stateContext).toBeDefined();

 const stateValue = stateContext?.value;
 expect(stateValue.cart.rawItems).toEqual(['order test item']);
 expect(stateValue.counter.count).toBe(2);
});

2 changes: 2 additions & 0 deletions
docs/migration/v8-to-v9.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -357,10 +357,12 @@ All exports and APIs of `@sentry/utils` and `@sentry/types` (except for the ones
 ```

- The option `logErrors` in the `vueIntegration` has been removed. The Sentry Vue error handler will always propagate the error to a user-defined error handler or re-throw the error (which will log the error without modifying).
- The option `stateTransformer` in `createSentryPiniaPlugin()` now receives the full state from all stores as its parameter. The top-level keys of the state object are the store IDs.

### `@sentry/nuxt`

- The `tracingOptions` option in `Sentry.init()` was removed in favor of passing the `vueIntegration()` to `Sentry.init({ integrations: [...] })` and setting `tracingOptions` there.
- The option `stateTransformer` in the `piniaIntegration` now receives the full state from all stores as its parameter. The top-level keys of the state object are the store IDs.

### `@sentry/vue` and `@sentry/nuxt`

Expand Down

34 changes: 24 additions & 10 deletions
packages/vue/src/pinia.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,19 +1,22 @@
import { addBreadcrumb, addNonEnumerableProperty, getClient, getCurrentScope, getGlobalScope } from '@sentry/core';
import type { Ref } from 'vue';

// Inline PiniaPlugin type
// Inline Pinia types
type StateTree = Record<string | number | symbol, any>;
type PiniaPlugin = (context: {
 store: {
 $id: string;
 $state: unknown;
 $onAction: (callback: (context: { name: string; after: (callback: () => void) => void }) => void) => void;
 };
 pinia: { state: Ref<Record<string, StateTree>> };
}) => void;

type SentryPiniaPluginOptions = {
 attachPiniaState?: boolean;
 addBreadcrumbs?: boolean;
 actionTransformer?: (action: any) => any;
 stateTransformer?: (state: any) => any;
 actionTransformer?: (action: string) => any;
 stateTransformer?: (state: Record<string, unknown>) => any;
};

export const createSentryPiniaPlugin: (options?: SentryPiniaPluginOptions) => PiniaPlugin = (
Expand All@@ -24,19 +27,29 @@ export const createSentryPiniaPlugin: (options?: SentryPiniaPluginOptions) => Pi
 stateTransformer: state => state,
 },
) => {
 const plugin: PiniaPlugin = ({ store }) => {
 const plugin: PiniaPlugin = ({ store, pinia }) => {
 const getAllStoreStates = (): Record<string, unknown> => {
 const states: Record<string, unknown> = {};

 Object.keys(pinia.state.value).forEach(storeId => {
 states[storeId] = pinia.state.value[storeId];
 });

 return states;
 };

 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`;
 const filename = `pinia_state_all_stores_${timestamp}.json`;

 hint.attachments = [
 ...(hint.attachments || []),
 {
 filename,
 data: JSON.stringify(store.$state),
 data: JSON.stringify(getAllStoreStates()),
 },
 ];
 } catch (_) {
Expand All@@ -58,14 +71,15 @@ export const createSentryPiniaPlugin: (options?: SentryPiniaPluginOptions) => Pi
 options.addBreadcrumbs !== false
 ) {
 addBreadcrumb({
 category: 'action',
 message: transformedActionName,
 category: 'pinia.action',
 message: `Store: ${store.$id} | Action: ${transformedActionName}`,
 level: 'info',
 });
 }

 /* Set latest state to scope */
 const transformedState = options.stateTransformer ? options.stateTransformer(store.$state) : store.$state;
 /* Set latest state of all stores to scope */
 const allStates = getAllStoreStates();
 const transformedState = options.stateTransformer ? options.stateTransformer(allStates) : allStates;
 const scope = getCurrentScope();
 const currentState = scope.getScopeData().contexts.state;

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(pinia)!: Include state of all stores in breadcrumb#15312

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

s1gr1d
merged 2 commits into

from

Feb 5, 2025
 Merged


feat(pinia)!: Include state of all stores in breadcrumb
#15312
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
142be3c

feat(pinia): Include state of all stores in breadcrumb


s1gr1d Feb 5, 2025
4dd428d

fix nuxt e2e test


s1gr1d Feb 5, 2025

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


2 changes: 1 addition & 1 deletion
dev-packages/e2e-tests/test-applications/nuxt-4/sentry.client.config.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@ Sentry.init({
 tracesSampleRate: 1.0,
 integrations: [
 Sentry.piniaIntegration(usePinia(), {
 actionTransformer: action => `Transformed: ${action}`,
 actionTransformer: action => `${action}.transformed`,
 stateTransformer: state => ({
 transformed: true,
 ...state,
Expand Down

6 changes: 3 additions & 3 deletions
dev-packages/e2e-tests/test-applications/nuxt-4/tests/pinia.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,10 +18,10 @@ test('sends pinia action breadcrumbs and state context', async ({ page }) => {
 expect(error).toBeTruthy();
 expect(error.breadcrumbs?.length).toBeGreaterThan(0);

 const actionBreadcrumb = error.breadcrumbs?.find(breadcrumb => breadcrumb.category === 'action');
 const actionBreadcrumb = error.breadcrumbs?.find(breadcrumb => breadcrumb.category === 'pinia.action');

 expect(actionBreadcrumb).toBeDefined();
 expect(actionBreadcrumb?.message).toBe('Transformed: addItem');
 expect(actionBreadcrumb?.message).toBe('Store: cart | Action: addItem.transformed');
 expect(actionBreadcrumb?.level).toBe('info');

 const stateContext = error.contexts?.state?.state;
Expand All@@ -30,6 +30,6 @@ test('sends pinia action breadcrumbs and state context', async ({ page }) => {
 expect(stateContext?.type).toBe('pinia');
 expect(stateContext?.value).toEqual({
 transformed: true,
 rawItems: ['item'],
cart: { rawItems: ['item'] },
 });
});

2 changes: 1 addition & 1 deletion
dev-packages/e2e-tests/test-applications/vue-3/src/main.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,7 +31,7 @@ Sentry.init({

pinia.use(
 Sentry.createSentryPiniaPlugin({
 actionTransformer: action => `Transformed: ${action}`,
 actionTransformer: action => `${action}.transformed`,
 stateTransformer: state => ({
 transformed: true,
 ...state,
Expand Down

3 changes: 1 addition & 2 deletions
dev-packages/e2e-tests/test-applications/vue-3/src/stores/cart.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
import { acceptHMRUpdate, defineStore } from 'pinia';

export const useCartStore = defineStore({
 id: 'cart',
export const useCartStore = defineStore('cart', {
 state: () => ({
 rawItems: [] as string[],
 }),
Expand Down

10 changes: 10 additions & 0 deletions
dev-packages/e2e-tests/test-applications/vue-3/src/stores/counter.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
import { defineStore } from 'pinia';

export const useCounterStore = defineStore('counter', {
 state: () => ({ name: 'Counter Store', count: 0 }),
 actions: {
 increment() {
 this.count++;
 },
 },
});

61 changes: 28 additions & 33 deletions
dev-packages/e2e-tests/test-applications/vue-3/src/views/CartView.vue

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,50 +29,45 @@
 data-testid="clear"
 >Clear the cart</button>
 </form>

 <br/>

 <div>
 <h3>Counter: {{ $counter.count }}</h3>
 <button @click="$counter.increment">+</button>
 </div>
 </div>
 </Layout>
</template>

<script lang="ts">
import { defineComponent, ref } from 'vue'
<script setup lang="ts">
import { ref } from 'vue'
import { useCartStore } from '../stores/cart'
import { useCounterStore } from '@/stores/counter';

const cart = useCartStore()
const $counter = useCounterStore()

export default defineComponent({
 setup() {
 const cart = useCartStore()

 const itemName = ref('')

 function addItemToCart() {
 if (!itemName.value) return
 cart.addItem(itemName.value)
 itemName.value = ''
 }
const itemName = ref('')

 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 = []
 }
 }
function addItemToCart() {
 if (!itemName.value) return
 cart.addItem(itemName.value)
 itemName.value = ''
}

 // @ts-ignore
 window.stores = { cart }
function throwError() {
 throw new Error('This is an error')
}

 return {
 itemName,
 addItemToCart,
 cart,
function clearCart() {
 if (window.confirm('Are you sure you want to clear the cart?')) {
 cart.rawItems = []
 }
}

 throwError,
 clearCart,
 }
 },
})
// @ts-ignore
window.stores = { cart }
</script>

<style scoped>
Expand Down

75 changes: 72 additions & 3 deletions
dev-packages/e2e-tests/test-applications/vue-3/tests/pinia.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,10 +18,10 @@ test('sends pinia action breadcrumbs and state context', async ({ page }) => {
 expect(error).toBeTruthy();
 expect(error.breadcrumbs?.length).toBeGreaterThan(0);

 const actionBreadcrumb = error.breadcrumbs?.find(breadcrumb => breadcrumb.category === 'action');
 const actionBreadcrumb = error.breadcrumbs?.find(breadcrumb => breadcrumb.category === 'pinia.action');

 expect(actionBreadcrumb).toBeDefined();
 expect(actionBreadcrumb?.message).toBe('Transformed: addItem');
 expect(actionBreadcrumb?.message).toBe('Store: cart | Action: addItem.transformed');
 expect(actionBreadcrumb?.level).toBe('info');

 const stateContext = error.contexts?.state?.state;
Expand All@@ -30,6 +30,75 @@ test('sends pinia action breadcrumbs and state context', async ({ page }) => {
 expect(stateContext?.type).toBe('pinia');
 expect(stateContext?.value).toEqual({
 transformed: true,
 rawItems: ['item'],
 cart: {
 rawItems: ['item'],
 },
 counter: {
 count: 0,
 name: 'Counter Store',
 },
 });
});

test('state transformer receives full state object and is stored in state context', async ({ page }) => {
 await page.goto('/cart');

 await page.locator('#item-input').fill('multiple store test');
 await page.locator('#item-add').click();

 await page.locator('button:text("+")').click();
 await page.locator('button:text("+")').click();
 await page.locator('button:text("+")').click();

 await page.locator('#item-input').fill('multiple store pinia');
 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;

 // Verify stateTransformer was called with full state and modified state
 const stateContext = error.contexts?.state?.state;

 expect(stateContext?.value).toEqual({
 transformed: true,
 cart: {
 rawItems: ['multiple store test', 'multiple store pinia'],
 },
 counter: {
 name: 'Counter Store',
 count: 3,
 },
 });
});

test('different store interaction order maintains full state tracking', async ({ page }) => {
 await page.goto('/cart');

 await page.locator('button:text("+")').click();

 await page.locator('#item-input').fill('order test item');
 await page.locator('#item-add').click();

 await page.locator('button:text("+")').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;

 const stateContext = error.contexts?.state?.state;

 expect(stateContext).toBeDefined();

 const stateValue = stateContext?.value;
 expect(stateValue.cart.rawItems).toEqual(['order test item']);
 expect(stateValue.counter.count).toBe(2);
});

2 changes: 2 additions & 0 deletions
docs/migration/v8-to-v9.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -357,10 +357,12 @@ All exports and APIs of `@sentry/utils` and `@sentry/types` (except for the ones
 ```

- The option `logErrors` in the `vueIntegration` has been removed. The Sentry Vue error handler will always propagate the error to a user-defined error handler or re-throw the error (which will log the error without modifying).
- The option `stateTransformer` in `createSentryPiniaPlugin()` now receives the full state from all stores as its parameter. The top-level keys of the state object are the store IDs.

### `@sentry/nuxt`

- The `tracingOptions` option in `Sentry.init()` was removed in favor of passing the `vueIntegration()` to `Sentry.init({ integrations: [...] })` and setting `tracingOptions` there.
- The option `stateTransformer` in the `piniaIntegration` now receives the full state from all stores as its parameter. The top-level keys of the state object are the store IDs.

### `@sentry/vue` and `@sentry/nuxt`

Expand Down

34 changes: 24 additions & 10 deletions
packages/vue/src/pinia.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,19 +1,22 @@
import { addBreadcrumb, addNonEnumerableProperty, getClient, getCurrentScope, getGlobalScope } from '@sentry/core';
import type { Ref } from 'vue';

// Inline PiniaPlugin type
// Inline Pinia types
type StateTree = Record<string | number | symbol, any>;
type PiniaPlugin = (context: {
 store: {
 $id: string;
 $state: unknown;
 $onAction: (callback: (context: { name: string; after: (callback: () => void) => void }) => void) => void;
 };
 pinia: { state: Ref<Record<string, StateTree>> };
}) => void;

type SentryPiniaPluginOptions = {
 attachPiniaState?: boolean;
 addBreadcrumbs?: boolean;
 actionTransformer?: (action: any) => any;
 stateTransformer?: (state: any) => any;
 actionTransformer?: (action: string) => any;
 stateTransformer?: (state: Record<string, unknown>) => any;
};

export const createSentryPiniaPlugin: (options?: SentryPiniaPluginOptions) => PiniaPlugin = (
Expand All@@ -24,19 +27,29 @@ export const createSentryPiniaPlugin: (options?: SentryPiniaPluginOptions) => Pi
 stateTransformer: state => state,
 },
) => {
 const plugin: PiniaPlugin = ({ store }) => {
 const plugin: PiniaPlugin = ({ store, pinia }) => {
 const getAllStoreStates = (): Record<string, unknown> => {
 const states: Record<string, unknown> = {};

 Object.keys(pinia.state.value).forEach(storeId => {
 states[storeId] = pinia.state.value[storeId];
 });

 return states;
 };

 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`;
 const filename = `pinia_state_all_stores_${timestamp}.json`;

 hint.attachments = [
 ...(hint.attachments || []),
 {
 filename,
 data: JSON.stringify(store.$state),
 data: JSON.stringify(getAllStoreStates()),
 },
 ];
 } catch (_) {
Expand All@@ -58,14 +71,15 @@ export const createSentryPiniaPlugin: (options?: SentryPiniaPluginOptions) => Pi
 options.addBreadcrumbs !== false
 ) {
 addBreadcrumb({
 category: 'action',
 message: transformedActionName,
 category: 'pinia.action',
 message: `Store: ${store.$id} | Action: ${transformedActionName}`,
 level: 'info',
 });
 }

 /* Set latest state to scope */
 const transformedState = options.stateTransformer ? options.stateTransformer(store.$state) : store.$state;
 /* Set latest state of all stores to scope */
 const allStates = getAllStoreStates();
 const transformedState = options.stateTransformer ? options.stateTransformer(allStates) : allStates;
 const scope = getCurrentScope();
 const currentState = scope.getScopeData().contexts.state;

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
feat(pinia)!: Include state of all stores in breadcrumb#15312

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

s1gr1d
merged 2 commits into

from

Feb 5, 2025
 Merged


feat(pinia)!: Include state of all stores in breadcrumb
#15312
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
142be3c

feat(pinia): Include state of all stores in breadcrumb


s1gr1d Feb 5, 2025
4dd428d

fix nuxt e2e test


s1gr1d Feb 5, 2025

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


2 changes: 1 addition & 1 deletion
dev-packages/e2e-tests/test-applications/nuxt-4/sentry.client.config.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@ Sentry.init({
 tracesSampleRate: 1.0,
 integrations: [
 Sentry.piniaIntegration(usePinia(), {
 actionTransformer: action => `Transformed: ${action}`,
 actionTransformer: action => `${action}.transformed`,
 stateTransformer: state => ({
 transformed: true,
 ...state,
Expand Down

6 changes: 3 additions & 3 deletions
dev-packages/e2e-tests/test-applications/nuxt-4/tests/pinia.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,10 +18,10 @@ test('sends pinia action breadcrumbs and state context', async ({ page }) => {
 expect(error).toBeTruthy();
 expect(error.breadcrumbs?.length).toBeGreaterThan(0);

 const actionBreadcrumb = error.breadcrumbs?.find(breadcrumb => breadcrumb.category === 'action');
 const actionBreadcrumb = error.breadcrumbs?.find(breadcrumb => breadcrumb.category === 'pinia.action');

 expect(actionBreadcrumb).toBeDefined();
 expect(actionBreadcrumb?.message).toBe('Transformed: addItem');
 expect(actionBreadcrumb?.message).toBe('Store: cart | Action: addItem.transformed');
 expect(actionBreadcrumb?.level).toBe('info');

 const stateContext = error.contexts?.state?.state;
Expand All@@ -30,6 +30,6 @@ test('sends pinia action breadcrumbs and state context', async ({ page }) => {
 expect(stateContext?.type).toBe('pinia');
 expect(stateContext?.value).toEqual({
 transformed: true,
 rawItems: ['item'],
cart: { rawItems: ['item'] },
 });
});

2 changes: 1 addition & 1 deletion
dev-packages/e2e-tests/test-applications/vue-3/src/main.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,7 +31,7 @@ Sentry.init({

pinia.use(
 Sentry.createSentryPiniaPlugin({
 actionTransformer: action => `Transformed: ${action}`,
 actionTransformer: action => `${action}.transformed`,
 stateTransformer: state => ({
 transformed: true,
 ...state,
Expand Down

3 changes: 1 addition & 2 deletions
dev-packages/e2e-tests/test-applications/vue-3/src/stores/cart.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
import { acceptHMRUpdate, defineStore } from 'pinia';

export const useCartStore = defineStore({
 id: 'cart',
export const useCartStore = defineStore('cart', {
 state: () => ({
 rawItems: [] as string[],
 }),
Expand Down

10 changes: 10 additions & 0 deletions
dev-packages/e2e-tests/test-applications/vue-3/src/stores/counter.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
import { defineStore } from 'pinia';

export const useCounterStore = defineStore('counter', {
 state: () => ({ name: 'Counter Store', count: 0 }),
 actions: {
 increment() {
 this.count++;
 },
 },
});

61 changes: 28 additions & 33 deletions
dev-packages/e2e-tests/test-applications/vue-3/src/views/CartView.vue

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,50 +29,45 @@
 data-testid="clear"
 >Clear the cart</button>
 </form>

 <br/>

 <div>
 <h3>Counter: {{ $counter.count }}</h3>
 <button @click="$counter.increment">+</button>
 </div>
 </div>
 </Layout>
</template>

<script lang="ts">
import { defineComponent, ref } from 'vue'
<script setup lang="ts">
import { ref } from 'vue'
import { useCartStore } from '../stores/cart'
import { useCounterStore } from '@/stores/counter';

const cart = useCartStore()
const $counter = useCounterStore()

export default defineComponent({
 setup() {
 const cart = useCartStore()

 const itemName = ref('')

 function addItemToCart() {
 if (!itemName.value) return
 cart.addItem(itemName.value)
 itemName.value = ''
 }
const itemName = ref('')

 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 = []
 }
 }
function addItemToCart() {
 if (!itemName.value) return
 cart.addItem(itemName.value)
 itemName.value = ''
}

 // @ts-ignore
 window.stores = { cart }
function throwError() {
 throw new Error('This is an error')
}

 return {
 itemName,
 addItemToCart,
 cart,
function clearCart() {
 if (window.confirm('Are you sure you want to clear the cart?')) {
 cart.rawItems = []
 }
}

 throwError,
 clearCart,
 }
 },
})
// @ts-ignore
window.stores = { cart }
</script>

<style scoped>
Expand Down

75 changes: 72 additions & 3 deletions
dev-packages/e2e-tests/test-applications/vue-3/tests/pinia.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,10 +18,10 @@ test('sends pinia action breadcrumbs and state context', async ({ page }) => {
 expect(error).toBeTruthy();
 expect(error.breadcrumbs?.length).toBeGreaterThan(0);

 const actionBreadcrumb = error.breadcrumbs?.find(breadcrumb => breadcrumb.category === 'action');
 const actionBreadcrumb = error.breadcrumbs?.find(breadcrumb => breadcrumb.category === 'pinia.action');

 expect(actionBreadcrumb).toBeDefined();
 expect(actionBreadcrumb?.message).toBe('Transformed: addItem');
 expect(actionBreadcrumb?.message).toBe('Store: cart | Action: addItem.transformed');
 expect(actionBreadcrumb?.level).toBe('info');

 const stateContext = error.contexts?.state?.state;
Expand All@@ -30,6 +30,75 @@ test('sends pinia action breadcrumbs and state context', async ({ page }) => {
 expect(stateContext?.type).toBe('pinia');
 expect(stateContext?.value).toEqual({
 transformed: true,
 rawItems: ['item'],
 cart: {
 rawItems: ['item'],
 },
 counter: {
 count: 0,
 name: 'Counter Store',
 },
 });
});

test('state transformer receives full state object and is stored in state context', async ({ page }) => {
 await page.goto('/cart');

 await page.locator('#item-input').fill('multiple store test');
 await page.locator('#item-add').click();

 await page.locator('button:text("+")').click();
 await page.locator('button:text("+")').click();
 await page.locator('button:text("+")').click();

 await page.locator('#item-input').fill('multiple store pinia');
 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;

 // Verify stateTransformer was called with full state and modified state
 const stateContext = error.contexts?.state?.state;

 expect(stateContext?.value).toEqual({
 transformed: true,
 cart: {
 rawItems: ['multiple store test', 'multiple store pinia'],
 },
 counter: {
 name: 'Counter Store',
 count: 3,
 },
 });
});

test('different store interaction order maintains full state tracking', async ({ page }) => {
 await page.goto('/cart');

 await page.locator('button:text("+")').click();

 await page.locator('#item-input').fill('order test item');
 await page.locator('#item-add').click();

 await page.locator('button:text("+")').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;

 const stateContext = error.contexts?.state?.state;

 expect(stateContext).toBeDefined();

 const stateValue = stateContext?.value;
 expect(stateValue.cart.rawItems).toEqual(['order test item']);
 expect(stateValue.counter.count).toBe(2);
});

2 changes: 2 additions & 0 deletions
docs/migration/v8-to-v9.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -357,10 +357,12 @@ All exports and APIs of `@sentry/utils` and `@sentry/types` (except for the ones
 ```

- The option `logErrors` in the `vueIntegration` has been removed. The Sentry Vue error handler will always propagate the error to a user-defined error handler or re-throw the error (which will log the error without modifying).
- The option `stateTransformer` in `createSentryPiniaPlugin()` now receives the full state from all stores as its parameter. The top-level keys of the state object are the store IDs.

### `@sentry/nuxt`

- The `tracingOptions` option in `Sentry.init()` was removed in favor of passing the `vueIntegration()` to `Sentry.init({ integrations: [...] })` and setting `tracingOptions` there.
- The option `stateTransformer` in the `piniaIntegration` now receives the full state from all stores as its parameter. The top-level keys of the state object are the store IDs.

### `@sentry/vue` and `@sentry/nuxt`

Expand Down

34 changes: 24 additions & 10 deletions
packages/vue/src/pinia.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,19 +1,22 @@
import { addBreadcrumb, addNonEnumerableProperty, getClient, getCurrentScope, getGlobalScope } from '@sentry/core';
import type { Ref } from 'vue';

// Inline PiniaPlugin type
// Inline Pinia types
type StateTree = Record<string | number | symbol, any>;
type PiniaPlugin = (context: {
 store: {
 $id: string;
 $state: unknown;
 $onAction: (callback: (context: { name: string; after: (callback: () => void) => void }) => void) => void;
 };
 pinia: { state: Ref<Record<string, StateTree>> };
}) => void;

type SentryPiniaPluginOptions = {
 attachPiniaState?: boolean;
 addBreadcrumbs?: boolean;
 actionTransformer?: (action: any) => any;
 stateTransformer?: (state: any) => any;
 actionTransformer?: (action: string) => any;
 stateTransformer?: (state: Record<string, unknown>) => any;
};

export const createSentryPiniaPlugin: (options?: SentryPiniaPluginOptions) => PiniaPlugin = (
Expand All@@ -24,19 +27,29 @@ export const createSentryPiniaPlugin: (options?: SentryPiniaPluginOptions) => Pi
 stateTransformer: state => state,
 },
) => {
 const plugin: PiniaPlugin = ({ store }) => {
 const plugin: PiniaPlugin = ({ store, pinia }) => {
 const getAllStoreStates = (): Record<string, unknown> => {
 const states: Record<string, unknown> = {};

 Object.keys(pinia.state.value).forEach(storeId => {
 states[storeId] = pinia.state.value[storeId];
 });

 return states;
 };

 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`;
 const filename = `pinia_state_all_stores_${timestamp}.json`;

 hint.attachments = [
 ...(hint.attachments || []),
 {
 filename,
 data: JSON.stringify(store.$state),
 data: JSON.stringify(getAllStoreStates()),
 },
 ];
 } catch (_) {
Expand All@@ -58,14 +71,15 @@ export const createSentryPiniaPlugin: (options?: SentryPiniaPluginOptions) => Pi
 options.addBreadcrumbs !== false
 ) {
 addBreadcrumb({
 category: 'action',
 message: transformedActionName,
 category: 'pinia.action',
 message: `Store: ${store.$id} | Action: ${transformedActionName}`,
 level: 'info',
 });
 }

 /* Set latest state to scope */
 const transformedState = options.stateTransformer ? options.stateTransformer(store.$state) : store.$state;
 /* Set latest state of all stores to scope */
 const allStates = getAllStoreStates();
 const transformedState = options.stateTransformer ? options.stateTransformer(allStates) : allStates;
 const scope = getCurrentScope();
 const currentState = scope.getScopeData().contexts.state;

Expand Down