feat(nuxt): Add `piniaIntegration` #14138

s1gr1d · 2024-10-30T12:22:09Z

After reverting #14134, this is a more bundle-size friendly way of adding monitoring for Pinia in Nuxt.

The Nuxt SDK now allows you to track Pinia state for captured errors. To enable the Pinia plugin, add the piniaIntegration to your client config:

// sentry.client.config.ts
import { usePinia } from '#imports';

Sentry.init({
  integrations: [
    Sentry.piniaIntegration(usePinia(), {
      /* optional Pinia plugin options */
    }),
  ],
});

andreiborza · 2024-10-30T12:44:45Z

CHANGELOG.md

@@ -10,6 +10,73 @@

 - "You miss 100 percent of the chances you don't take. — Wayne Gretzky" — Michael Scott

+- **feat(nuxt): Add Sentry Pinia plugin ([#14138](https://github.com/getsentry/sentry-javascript/pull/14138))**


m: the PR description here doesn't match the actual PR

andreiborza · 2024-10-31T08:25:44Z

packages/nuxt/src/client/piniaIntegration.ts

+        consoleSandbox(() => {
+          // eslint-disable-next-line no-console
+          console.warn(
+            '[Sentry] You added the Pinia integration, but the passed parameter `pinia` has the wrong value. Make sure to enable Pinia by adding `"@pinia/nuxt"` to your Nuxt modules array and pass pinia to Sentry with `piniaIntegration(usePinia())`. Current value of `pinia`: ',


ultra-l: I'd change the prose and remove the you/your

Passive language: "The pinia integration was configured/added, ..."

andreiborza · 2024-10-31T08:27:13Z

packages/nuxt/src/client/piniaIntegration.ts

+        consoleSandbox(() => {
+          // eslint-disable-next-line no-console
+          console.warn(
+            '[Sentry] You added the Pinia integration, but the passed parameter `pinia` has the wrong value. Make sure to enable Pinia by adding `"@pinia/nuxt"` to your Nuxt modules array and pass pinia to Sentry with `piniaIntegration(usePinia())`. Current value of `pinia`: ',


l: You don't need the extra space after :, a space is rendered by default between arguments passed to console logs.

chargome

lgtm, I'm just confused about the changelog

chargome · 2024-10-31T08:47:00Z

CHANGELOG.md

+Sentry.init({
+  integrations: [
+    Sentry.piniaIntegration(usePinia(), {
+      /* optinal Pinia plugin options */


Suggested change

/* optinal Pinia plugin options */

/* optional Pinia plugin options */

codecov · 2024-10-31T13:22:42Z

❌ 1 Tests Failed:

Tests completed	Failed	Passed	Skipped
233	1	232	9

View the top 1 failed tests by shortest run time

client-app-routing-instrumentation.test.ts Creates a navigation transaction for app router routes

Stack Traces | 30s run time

client-app-routing-instrumentation.test.ts:19:5 Creates a navigation transaction for app router routes

To view individual test run time comparison to the main branch, go to the Test Analytics Dashboard

Lms24 · 2024-11-04T08:42:21Z

dev-packages/e2e-tests/test-applications/nuxt-4/tests/pinia.test.ts

+  expect(actionBreadcrumb?.message).toBe('Transformed: addItem');
+  expect(actionBreadcrumb?.level).toBe('info');
+
+  const stateContext = error.contexts?.state?.state;


q (probably no action required): Are the double state keys on purpose?

Yes, this is on purpose: https://develop.sentry.dev/sdk/data-model/event-payloads/contexts/#state-context

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [@sentry/node](https://github.com/getsentry/sentry-javascript/tree/master/packages/node) ([source](https://github.com/getsentry/sentry-javascript)) | dependencies | minor | [`8.36.0` -> `8.37.1`](https://renovatebot.com/diffs/npm/@sentry%2fnode/8.36.0/8.37.1) | | [@sentry/react](https://github.com/getsentry/sentry-javascript/tree/master/packages/react) ([source](https://github.com/getsentry/sentry-javascript)) | dependencies | minor | [`8.36.0` -> `8.37.1`](https://renovatebot.com/diffs/npm/@sentry%2freact/8.36.0/8.37.1) | --- ### Release Notes <details> <summary>getsentry/sentry-javascript (@sentry/node)</summary> ### [`v8.37.1`](https://github.com/getsentry/sentry-javascript/blob/HEAD/CHANGELOG.md#8371) [Compare Source](getsentry/sentry-javascript@8.37.0...8.37.1) - feat(deps): Bump [@opentelemetry/instrumentation](https://github.com/opentelemetry/instrumentation) from 0.53.0 to 0.54.0 for [@sentry/opentelemetry](https://github.com/sentry/opentelemetry) ([#14187](getsentry/sentry-javascript#14187)) ### [`v8.37.0`](https://github.com/getsentry/sentry-javascript/blob/HEAD/CHANGELOG.md#8370) [Compare Source](getsentry/sentry-javascript@8.36.0...8.37.0) ##### Important Changes - **feat(nuxt): Add `piniaIntegration` ([#14138](getsentry/sentry-javascript#14138 The Nuxt SDK now allows you to track Pinia state for captured errors. To enable the Pinia plugin, add the `piniaIntegration` to your client config: ```ts // sentry.client.config.ts import { usePinia } from '#imports'; Sentry.init({ integrations: [ Sentry.piniaIntegration(usePinia(), { /* optional Pinia plugin options */ }), ], }); ``` - **feat: Deprecate metrics API ([#14157](getsentry/sentry-javascript#14157 The Sentry Metrics beta has ended in favour of revisiting metrics in another form at a later date. This new approach will include different APIs, making the current metrics API unnecessary. This release deprecates the metrics API with the plan to remove in the next SDK major version. If you currently use the metrics API in your code, you can safely continue to do so but sent data will no longer be processed by Sentry. [Learn more](https://sentry.zendesk.com/hc/en-us/articles/26369339769883-Metrics-Beta-Ended-on-October-7th) about the end of the Metrics beta. ##### Other Changes - feat(browser): Add `http.response_delivery_type` attribute to resource spans ([#14056](getsentry/sentry-javascript#14056)) - feat(browser): Add `skipBrowserExtensionCheck` escape hatch option ([#14147](getsentry/sentry-javascript#14147)) - feat(deps): Bump [@opentelemetry/instrumentation](https://github.com/opentelemetry/instrumentation) from 0.53.0 to 0.54.0 ([#14174](getsentry/sentry-javascript#14174)) - feat(deps): Bump [@opentelemetry/instrumentation-fastify](https://github.com/opentelemetry/instrumentation-fastify) from 0.40.0 to 0.41.0 ([#14175](getsentry/sentry-javascript#14175)) - feat(deps): Bump [@opentelemetry/instrumentation-graphql](https://github.com/opentelemetry/instrumentation-graphql) from 0.43.0 to 0.44.0 ([#14173](getsentry/sentry-javascript#14173)) - feat(deps): Bump [@opentelemetry/instrumentation-mongodb](https://github.com/opentelemetry/instrumentation-mongodb) from 0.47.0 to 0.48.0 ([#14171](getsentry/sentry-javascript#14171)) - feat(deps): Bump [@opentelemetry/propagator-aws-xray](https://github.com/opentelemetry/propagator-aws-xray) from 1.25.1 to 1.26.0 ([#14172](getsentry/sentry-javascript#14172)) - feat(nuxt): Add `asyncFunctionReExports` to define re-exported server functions ([#14104](getsentry/sentry-javascript#14104)) - feat(nuxt): Add `piniaIntegration` ([#14138](getsentry/sentry-javascript#14138)) - fix(browser): Avoid recording long task spans starting before their parent span ([#14183](getsentry/sentry-javascript#14183)) - fix(core): Ensure errors thrown in async cron jobs bubble up ([#14182](getsentry/sentry-javascript#14182)) - fix(core): Silently fail `maybeInstrument` ([#14140](getsentry/sentry-javascript#14140)) - fix(nextjs): Resolve path for dynamic webpack import ([#13751](getsentry/sentry-javascript#13751)) - fix(node): Make sure `modulesIntegration` does not crash esm apps ([#14169](getsentry/sentry-javascript#14169)) Work in this release was contributed by [@rexxars](https://github.com/rexxars). Thank you for your contribution! </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about these updates again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Reviewed-on: https://git.tristess.app/alexandresoro/ouca/pulls/299 Reviewed-by: Alexandre Soro <[email protected]> Co-authored-by: renovate <[email protected]> Co-committed-by: renovate <[email protected]>

s1gr1d force-pushed the sig/pinia-nuxt branch from 6c631ca to 7ace30b Compare October 30, 2024 12:28

feat(nuxt): Add piniaIntegration

3cd9bcc

s1gr1d force-pushed the sig/pinia-nuxt branch from 7ace30b to 3cd9bcc Compare October 30, 2024 12:29

s1gr1d changed the title ~~feat(nuxt): Add piniaIntegration~~ feat(nuxt): Add piniaIntegration Oct 30, 2024

s1gr1d requested review from lforst, Lms24 and chargome October 30, 2024 12:31

s1gr1d mentioned this pull request Oct 30, 2024

docs(nuxt): piniaIntegration in Nuxt getsentry/sentry-docs#11684

Merged

6 tasks

andreiborza reviewed Oct 31, 2024

View reviewed changes

chargome approved these changes Oct 31, 2024

View reviewed changes

s1gr1d added 4 commits October 31, 2024 14:06

review suggestion

b257c26

Merge branch 'refs/heads/develop' into sig/pinia-nuxt

90f0814

fix changelog entry

9406387

fix typo

cf8f24b

s1gr1d requested a review from andreiborza October 31, 2024 13:08

Lms24 approved these changes Nov 4, 2024

View reviewed changes

andreiborza approved these changes Nov 4, 2024

View reviewed changes

s1gr1d merged commit 738870d into develop Nov 4, 2024
118 checks passed

s1gr1d deleted the sig/pinia-nuxt branch November 4, 2024 08:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(nuxt): Add `piniaIntegration` #14138

feat(nuxt): Add `piniaIntegration` #14138

s1gr1d commented Oct 30, 2024 •

edited

Loading

andreiborza Oct 30, 2024

andreiborza Oct 31, 2024

lforst Oct 31, 2024

andreiborza Oct 31, 2024

chargome left a comment

chargome Oct 31, 2024

codecov bot commented Oct 31, 2024

Lms24 Nov 4, 2024

s1gr1d Nov 4, 2024

		@@ -10,6 +10,73 @@

		- "You miss 100 percent of the chances you don't take. — Wayne Gretzky" — Michael Scott

		- feat(nuxt): Add Sentry Pinia plugin ([#14138](https://github.com/getsentry/sentry-javascript/pull/14138))

	/* optinal Pinia plugin options */
	/* optional Pinia plugin options */

feat(nuxt): Add piniaIntegration #14138

feat(nuxt): Add piniaIntegration #14138

Conversation

s1gr1d commented Oct 30, 2024 • edited Loading

andreiborza Oct 30, 2024

Choose a reason for hiding this comment

andreiborza Oct 31, 2024

Choose a reason for hiding this comment

lforst Oct 31, 2024

Choose a reason for hiding this comment

andreiborza Oct 31, 2024

Choose a reason for hiding this comment

chargome left a comment

Choose a reason for hiding this comment

chargome Oct 31, 2024

Choose a reason for hiding this comment

codecov bot commented Oct 31, 2024

❌ 1 Tests Failed:

Lms24 Nov 4, 2024

Choose a reason for hiding this comment

s1gr1d Nov 4, 2024

Choose a reason for hiding this comment

feat(nuxt): Add `piniaIntegration` #14138

feat(nuxt): Add `piniaIntegration` #14138

s1gr1d commented Oct 30, 2024 •

edited

Loading