@sentry/nuxt 8.16.0 → 8.18.0

package/README.md

@@ -28,6 +28,31 @@ The minimum supported version of Nuxt is `3.0.0`.
 This package is a wrapper around `@sentry/node` for the server and `@sentry/vue` for the client side, with added
 functionality related to Nuxt.
 
+**What is working:**
+
+- Error Reporting
+  - Vue
+  - Node
+  - Nitro
+
+**What is partly working:**
+
+- Tracing by setting `tracesSampleRate`
+  - UI (Vue) traces
+  - HTTP (Node) traces
+
+**What is not yet(!) included:**
+
+- Source Maps
+- Nuxt-specific traces and connecting frontend & backend traces
+
+**Known Issues:**
+
+- When adding `sentry.server.config.(ts/js)`, you get this error: "Failed to register ESM hook", but the application
+  will still work
+- When initializing Sentry on the server with `instrument.server.(js|ts)`, you get an `'import-in-the-middle'` error,
+  and the application won't work
+
 ## Automatic Setup
 
 todo: add wizard instructions
@@ -83,10 +108,38 @@ Add a `sentry.server.config.(js|ts)` file to the root of your project:
 import * as Sentry from '@sentry/nuxt';
 
 Sentry.init({
-  dsn: env.DSN,
+  dsn: process.env.DSN,
 });
 ```
 
+**Alternative Setup (ESM-compatible)**
+
+This setup makes sure Sentry is imported on the server before any other imports. As of now, this however leads to an
+import-in-the-middle error ([related reproduction](https://github.com/getsentry/sentry-javascript-examples/pull/38)).
+
+Add an `instrument.server.mjs` file to your `public` folder:
+
+```javascript
+import * as Sentry from '@sentry/nuxt';
+
+// Only run `init` when DSN is available
+if (process.env.SENTRY_DSN) {
+  Sentry.init({
+    dsn: process.env.DSN,
+  });
+}
+```
+
+Add an import flag to the node options, so the file loads before any other imports:
+
+```json
+{
+  "scripts": {
+    "preview": "NODE_OPTIONS='--import ./public/instrument.server.mjs' nuxt preview"
+  }
+}
+```
+
 ### 5. Vite Setup
 
 todo: add vite setup

package/build/module/module.cjs

@@ -0,0 +1,5 @@
+module.exports = function(...args) {
+  return import('./module.mjs').then(m => m.default.call(this, ...args))
+}
+const _meta = module.exports.meta = require('./module.json')
+module.exports.getMeta = () => Promise.resolve(_meta)

package/build/module/module.d.mts

@@ -0,0 +1,9 @@
+import * as _nuxt_schema from '@nuxt/schema';
+import { init } from '@sentry/vue';
+
+type SentryNuxtOptions = Omit<Parameters<typeof init>[0] & object, 'app'>;
+
+type ModuleOptions = SentryNuxtOptions;
+declare const _default: _nuxt_schema.NuxtModule<SentryNuxtOptions>;
+
+export { type ModuleOptions, _default as default };

package/build/module/module.d.ts

@@ -0,0 +1,9 @@
+import * as _nuxt_schema from '@nuxt/schema';
+import { init } from '@sentry/vue';
+
+type SentryNuxtOptions = Omit<Parameters<typeof init>[0] & object, 'app'>;
+
+type ModuleOptions = SentryNuxtOptions;
+declare const _default: _nuxt_schema.NuxtModule<SentryNuxtOptions>;
+
+export { type ModuleOptions, _default as default };

package/build/module/module.json

@@ -0,0 +1,12 @@
+{
+  "name": "@sentry/nuxt/module",
+  "configKey": "sentry",
+  "compatibility": {
+    "nuxt": "^3.0.0"
+  },
+  "version": "8.18.0",
+  "builder": {
+    "@nuxt/module-builder": "0.8.0",
+    "unbuild": "2.0.0"
+  }
+}

package/build/module/module.mjs

@@ -0,0 +1,46 @@
+import * as fs from 'fs';
+import * as path from 'path';
+import { defineNuxtModule, createResolver, addPluginTemplate, addPlugin, addServerPlugin } from '@nuxt/kit';
+
+const module = defineNuxtModule({
+  meta: {
+    name: "@sentry/nuxt/module",
+    configKey: "sentry",
+    compatibility: {
+      nuxt: "^3.0.0"
+    }
+  },
+  defaults: {},
+  setup(_moduleOptions, nuxt) {
+    const moduleDirResolver = createResolver(import.meta.url);
+    const buildDirResolver = createResolver(nuxt.options.buildDir);
+    const clientConfigFile = findDefaultSdkInitFile("client");
+    if (clientConfigFile) {
+      addPluginTemplate({
+        mode: "client",
+        filename: "sentry-client-config.mjs",
+        getContents: () => `import "${buildDirResolver.resolve(`/${clientConfigFile}`)}"
+export default defineNuxtPlugin(() => {})`
+      });
+      addPlugin({ src: moduleDirResolver.resolve("./runtime/plugins/sentry.client"), mode: "client" });
+    }
+    const serverConfigFile = findDefaultSdkInitFile("server");
+    if (serverConfigFile) {
+      addPluginTemplate({
+        mode: "server",
+        filename: "sentry-server-config.mjs",
+        getContents: () => `import "${buildDirResolver.resolve(`/${serverConfigFile}`)}"
+export default defineNuxtPlugin(() => {})`
+      });
+      addServerPlugin(moduleDirResolver.resolve("./runtime/plugins/sentry.server"));
+    }
+  }
+});
+function findDefaultSdkInitFile(type) {
+  const possibleFileExtensions = ["ts", "js", "mjs", "cjs", "mts", "cts"];
+  const cwd = process.cwd();
+  const filePath = possibleFileExtensions.map((e) => path.resolve(path.join(cwd, `sentry.${type}.config.${e}`))).find((filename) => fs.existsSync(filename));
+  return filePath ? path.basename(filePath) : void 0;
+}
+
+export { module as default };

package/build/module/runtime/plugins/sentry.client.js

@@ -0,0 +1,11 @@
+import { getClient } from "@sentry/core";
+import { vueIntegration } from "@sentry/vue";
+import { defineNuxtPlugin } from "nuxt/app";
+export default defineNuxtPlugin((nuxtApp) => {
+  nuxtApp.hook("app:created", (vueApp) => {
+    const sentryClient = getClient();
+    if (sentryClient) {
+      sentryClient.addIntegration(vueIntegration({ app: vueApp }));
+    }
+  });
+});

package/build/module/runtime/plugins/sentry.server.js

@@ -0,0 +1,18 @@
+import { captureException } from "@sentry/node";
+import { H3Error } from "h3";
+import { defineNitroPlugin } from "nitropack/runtime";
+import { extractErrorContext } from "../utils.js";
+export default defineNitroPlugin((nitroApp) => {
+  nitroApp.hooks.hook("error", (error, errorContext) => {
+    if (error instanceof H3Error) {
+      if (error.statusCode >= 300 && error.statusCode < 500) {
+        return;
+      }
+    }
+    const structuredContext = extractErrorContext(errorContext);
+    captureException(error, {
+      captureContext: { contexts: { nuxt: structuredContext } },
+      mechanism: { handled: false }
+    });
+  });
+});

package/build/module/runtime/utils.js

@@ -0,0 +1,18 @@
+import { dropUndefinedKeys } from "@sentry/utils";
+export function extractErrorContext(errorContext) {
+  const structuredContext = {
+    method: void 0,
+    path: void 0,
+    tags: void 0
+  };
+  if (errorContext) {
+    if (errorContext.event) {
+      structuredContext.method = errorContext.event._method || void 0;
+      structuredContext.path = errorContext.event._path || void 0;
+    }
+    if (Array.isArray(errorContext.tags)) {
+      structuredContext.tags = errorContext.tags || void 0;
+    }
+  }
+  return dropUndefinedKeys(structuredContext);
+}

package/build/module/types.d.mts

@@ -0,0 +1 @@
+export { type ModuleOptions, default } from './module.js'

package/build/module/types.d.ts

@@ -0,0 +1 @@
+export { type ModuleOptions, default } from './module'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sentry/nuxt",
-  "version": "8.16.0",
+  "version": "8.18.0",
   "description": "Official Sentry SDK for Nuxt (EXPERIMENTAL)",
   "repository": "git://github.com/getsentry/sentry-javascript.git",
   "homepage": "https://github.com/getsentry/sentry-javascript/tree/master/packages/nuxt",
@@ -43,24 +43,24 @@
   },
   "dependencies": {
     "@nuxt/kit": "^3.12.2",
-    "@sentry/browser": "8.16.0",
-    "@sentry/core": "8.16.0",
-    "@sentry/node": "8.16.0",
-    "@sentry/opentelemetry": "8.16.0",
-    "@sentry/types": "8.16.0",
-    "@sentry/utils": "8.16.0",
+    "@sentry/browser": "8.18.0",
+    "@sentry/core": "8.18.0",
+    "@sentry/node": "8.18.0",
+    "@sentry/opentelemetry": "8.18.0",
+    "@sentry/types": "8.18.0",
+    "@sentry/utils": "8.18.0",
     "@sentry/vite-plugin": "2.20.1",
-    "@sentry/vue": "8.16.0"
+    "@sentry/vue": "8.18.0"
   },
   "devDependencies": {
     "@nuxt/module-builder": "0.8.0",
     "nuxt": "^3.12.2"
   },
   "scripts": {
-    "build": "run-p build:transpile build:types build:nuxt-module",
+    "build": "run-s build:types build:transpile",
     "build:dev": "yarn build",
     "build:nuxt-module": "nuxt-module-build build --outDir build/module",
-    "build:transpile": "rollup -c rollup.npm.config.mjs",
+    "build:transpile": "rollup -c rollup.npm.config.mjs && yarn build:nuxt-module",
     "build:types": "tsc -p tsconfig.types.json",
     "build:watch": "run-p build:transpile:watch build:types:watch",
     "build:dev:watch": "yarn build:watch",
@@ -84,10 +84,12 @@
       "build:transpile": {
         "dependsOn": [
           "^build:transpile",
-          "^build:types"
+          "^build:types",
+          "build:types"
         ],
         "outputs": [
-          "{projectRoot}/build",
+          "{projectRoot}/build/cjs",
+          "{projectRoot}/build/esm",
           "{projectRoot}/build/module"
         ]
       }