feat(nuxt): Adding simplifiedDeployment option to Nuxt module

getsentry · Sep 10, 2024 · 709592f · 709592f
1 parent 017e8f9
commit 709592f
Show file tree

Hide file tree

Showing 3 changed files with 61 additions and 11 deletions.
diff --git a/packages/nuxt/src/common/types.ts b/packages/nuxt/src/common/types.ts
@@ -99,4 +99,14 @@ export type SentryNuxtModuleOptions = {
    * Enabling this will give you, for example, logs about source maps.
    */
   debug?: boolean;
+
+  /**
+   * Enabling simplified deployment can be used for environments where modifying the node option `--import` is not possible.
+   * If this flag is `true`, the Sentry SDK will import the server config at the top of the server entry file to load the SDK on the server.
+   *
+   * Note that enabling this option only supports limited tracing instrumentation. Only http traces will be collected.
+   *
+   * @default false
+   */
+  simplifiedDeployment?: boolean;
 };
diff --git a/packages/nuxt/src/module.ts b/packages/nuxt/src/module.ts
@@ -1,6 +1,6 @@
 import { addPlugin, addPluginTemplate, addServerPlugin, createResolver, defineNuxtModule } from '@nuxt/kit';
 import type { SentryNuxtModuleOptions } from './common/types';
-import { addServerConfigToBuild } from './vite/addServerConfig';
+import { addSentryTopImport, addServerConfigToBuild } from './vite/addServerConfig';
 import { setupSourceMaps } from './vite/sourceMaps';
 import { findDefaultSdkInitFile } from './vite/utils';
 
@@ -62,15 +62,20 @@ export default defineNuxtModule<ModuleOptions>({
     if (clientConfigFile || serverConfigFile) {
       setupSourceMaps(moduleOptions, nuxt);
     }
-    if (serverConfigFile && serverConfigFile.includes('.server.config')) {
-      if (moduleOptions.debug) {
-        // eslint-disable-next-line no-console
-        console.log(
-          `[Sentry] Using your \`${serverConfigFile}\` file for the server-side Sentry configuration. In case you have a \`public/instrument.server\` file, the \`public/instrument.server\` file will be ignored. Make sure the file path in your node \`--import\` option matches the Sentry server config file in your \`.output\` folder and has a \`.mjs\` extension.`,
-        );
-      }
 
+    if (serverConfigFile && serverConfigFile.includes('.server.config')) {
       addServerConfigToBuild(moduleOptions, nuxt, serverConfigFile);
+
+      if (moduleOptions.simplifiedDeployment) {
+        addSentryTopImport(moduleOptions, nuxt);
+      } else {
+        if (moduleOptions.debug) {
+          // eslint-disable-next-line no-console
+          console.log(
+            `[Sentry] Using your \`${serverConfigFile}\` file for the server-side Sentry configuration. In case you have a \`public/instrument.server\` file, the \`public/instrument.server\` file will be ignored. Make sure the file path in your node \`--import\` option matches the Sentry server config file in your \`.output\` folder and has a \`.mjs\` extension.`,
+          );
+        }
+      }
     }
   },
 });
diff --git a/packages/nuxt/src/vite/addServerConfig.ts b/packages/nuxt/src/vite/addServerConfig.ts
@@ -1,5 +1,4 @@
 import * as fs from 'fs';
-import * as path from 'path';
 import { createResolver } from '@nuxt/kit';
 import type { Nuxt } from '@nuxt/schema';
 import type { SentryNuxtModuleOptions } from '../common/types';
@@ -30,8 +29,9 @@ export function addServerConfigToBuild(
      * This is necessary because we need to reference this file path in the node --import option.
      */
     nuxt.hook('close', async () => {
-      const source = path.resolve('.nuxt/dist/server/sentry.server.config.mjs');
-      const destination = path.resolve('.output/server/sentry.server.config.mjs');
+      const rootDirResolver = createResolver(nuxt.options.rootDir);
+      const source = rootDirResolver.resolve('.nuxt/dist/server/sentry.server.config.mjs');
+      const destination = rootDirResolver.resolve('.output/server/sentry.server.config.mjs');
 
       try {
         await fs.promises.access(source, fs.constants.F_OK);
@@ -55,3 +55,38 @@ export function addServerConfigToBuild(
     });
   });
 }
+
+/**
+ *  Adds the Sentry server config import at the top of the server entry file to load the SDK on the server.
+ *  This is necessary for environments where modifying the node option `--import` is not possible.
+ *  However, only limited tracing instrumentation is supported when doing this.
+ */
+export function addSentryTopImport(moduleOptions: SentryNuxtModuleOptions, nuxt: Nuxt): void {
+  nuxt.hook('close', async () => {
+    const rootDirResolver = createResolver(nuxt.options.rootDir);
+    const entryFilePath = rootDirResolver.resolve('.output/server/index.mjs');
+
+    try {
+      fs.readFile(entryFilePath, 'utf8', (err, data) => {
+        const updatedContent = `import './sentry.server.config.mjs';\n${data}`;
+
+        fs.writeFile(entryFilePath, updatedContent, 'utf8', () => {
+          if (moduleOptions.debug) {
+            // eslint-disable-next-line no-console
+            console.log(
+              `[Sentry] Successfully added the Sentry import to the server entry file "\`${entryFilePath}\`"`,
+            );
+          }
+        });
+      });
+    } catch (err) {
+      if (moduleOptions.debug) {
+        // eslint-disable-next-line no-console
+        console.warn(
+          `[Sentry] An error occurred when trying to add the Sentry import to the server entry file "\`${entryFilePath}\`":`,
+          err,
+        );
+      }
+    }
+  });
+}