refactor: only instrument user-defined storage

Author: logaretm

packages/nuxt/src/common/server-template.ts

@@ -0,0 +1,17 @@
+import { useNuxt } from '@nuxt/kit';
+import type { NuxtTemplate } from 'nuxt/schema';
+
+/**
+ * Adds a virtual file that can be used within the Nuxt Nitro server build.
+ * Available in NuxtKit v4, so we are porting it here.
+ * https://github.com/nuxt/nuxt/blob/d6df732eec1a3bd442bdb325b0335beb7e10cd64/packages/kit/src/template.ts#L55-L62
+ */
+export function addServerTemplate(template: NuxtTemplate): NuxtTemplate {
+  const nuxt = useNuxt();
+  if (template.filename) {
+    nuxt.options.nitro.virtual ||= {};
+    nuxt.options.nitro.virtual[template.filename] = template.getContents;
+  }
+
+  return template;
+}

packages/nuxt/src/module.ts

@@ -12,6 +12,7 @@ import type { SentryNuxtModuleOptions } from './common/types';
 import { addDynamicImportEntryFileWrapper, addSentryTopImport, addServerConfigToBuild } from './vite/addServerConfig';
 import { addMiddlewareImports, addMiddlewareInstrumentation } from './vite/middlewareConfig';
 import { setupSourceMaps } from './vite/sourceMaps';
+import { addStorageInstrumentation } from './vite/storageConfig';
 import { addOTelCommonJSImportAlias, findDefaultSdkInitFile } from './vite/utils';
 
 export type ModuleOptions = SentryNuxtModuleOptions;
@@ -90,7 +91,6 @@ export default defineNuxtModule<ModuleOptions>({
 
     if (serverConfigFile) {
       addServerPlugin(moduleDirResolver.resolve('./runtime/plugins/sentry.server'));
-      addServerPlugin(moduleDirResolver.resolve('./runtime/plugins/storage.server'));
 
       addPlugin({
         src: moduleDirResolver.resolve('./runtime/plugins/route-detector.server'),
@@ -127,6 +127,7 @@ export default defineNuxtModule<ModuleOptions>({
     // Preps the the middleware instrumentation module.
     if (serverConfigFile) {
       addMiddlewareImports();
+      addStorageInstrumentation(nuxt);
     }
 
     nuxt.hooks.hook('nitro:init', nitro => {

packages/nuxt/src/runtime/plugins/storage.server.ts

@@ -13,26 +13,25 @@ import {
 // eslint-disable-next-line import/no-extraneous-dependencies
 import { defineNitroPlugin, useStorage } from 'nitropack/runtime';
 import type { Driver } from 'unstorage';
+// @ts-expect-error - This is a virtual module
+import { userStorageMounts } from '#sentry/storage-config.mjs';
 
 /**
  * Creates a Nitro plugin that instruments the storage driver.
  */
 export default defineNitroPlugin(async _nitroApp => {
   // This runs at runtime when the Nitro server starts
   const storage = useStorage();
-
-  // exclude mounts that are not relevant for instrumentation for a few reasons:
-  // Nitro mounts some development-only mount points that are not relevant for instrumentation
-  // https://nitro.build/guide/storage#development-only-mount-points
-  const excludeMounts = new Set(['build:', 'cache:', 'root:', 'data:', 'src:', 'assets:']);
+  // Mounts are suffixed with a colon, so we need to add it to the set items
+  const userMounts = new Set((userStorageMounts as string[]).map(m => `${m}:`));
 
   debug.log('[Storage Instrumentation] Starting to instrument storage drivers...');
 
   // Get all mounted storage drivers
   const mounts = storage.getMounts();
   for (const mount of mounts) {
     // Skip excluded mounts and root mount
-    if (!mount.base || excludeMounts.has(mount.base)) {
+    if (!userMounts.has(mount.base)) {
       continue;
     }
 

packages/nuxt/src/vite/storageConfig.ts

@@ -0,0 +1,21 @@
+import { addServerPlugin, createResolver } from '@nuxt/kit';
+import type { Nuxt } from 'nuxt/schema';
+import { addServerTemplate } from '../common/server-template';
+
+/**
+ * Prepares the storage config export to be used in the runtime storage instrumentation.
+ */
+export function addStorageInstrumentation(nuxt: Nuxt): void {
+  const moduleDirResolver = createResolver(import.meta.url);
+  const userStorageMounts = Object.keys(nuxt.options.nitro.storage || {});
+
+  // Create a virtual module to pass this data to runtime
+  addServerTemplate({
+    filename: '#sentry/storage-config.mjs',
+    getContents: () => {
+      return `export const userStorageMounts = ${JSON.stringify(userStorageMounts)};`;
+    },
+  });
+
+  addServerPlugin(moduleDirResolver.resolve('./runtime/plugins/storage.server'));
+}