detect by plugin name

Author: nicohrubec

packages/tanstackstart-react/src/vite/copyInstrumentationFile.ts

@@ -20,27 +20,35 @@ export function makeCopyInstrumentationFilePlugin(): Plugin {
     enforce: 'post',
 
     configResolved(resolvedConfig: ResolvedConfig) {
-      // Nitro case: read server dir from the nitro environment config
-      // Vite 6 environment configs are not part of the public type definitions yet,
-      // so we need to access them via an index signature.
-      const environments = (resolvedConfig as Record<string, unknown>)['environments'] as
-        | Record<string, { build?: { rollupOptions?: { output?: { dir?: string } | Array<{ dir?: string }> } } }>
-        | undefined;
-      const nitroEnv = environments?.nitro;
-      if (nitroEnv) {
-        const rollupOutput = nitroEnv.build?.rollupOptions?.output;
-        const dir = Array.isArray(rollupOutput) ? rollupOutput[0]?.dir : rollupOutput?.dir;
-        if (dir) {
-          serverOutputDir = dir;
-          return;
-        }
-      }
-
-      // Cloudflare/Netlify case: detect by plugin name
       const plugins = resolvedConfig.plugins || [];
-      const hasCloudflareOrNetlify = plugins.some(p => /cloudflare|netlify/i.test(p.name));
-      if (hasCloudflareOrNetlify) {
+      const hasPlugin = (name: string): boolean => plugins.some(p => p.name === name);
+
+      if (hasPlugin('nitro')) {
+        // Nitro case: read server dir from the nitro environment config
+        // Vite 6 environment configs are not part of the public type definitions yet,
+        // so we need to access them via an index signature.
+        const environments = (resolvedConfig as Record<string, unknown>)['environments'] as
+          | Record<string, { build?: { rollupOptions?: { output?: { dir?: string } | Array<{ dir?: string }> } } }>
+          | undefined;
+        const nitroEnv = environments?.nitro;
+        if (nitroEnv) {
+          const rollupOutput = nitroEnv.build?.rollupOptions?.output;
+          const dir = Array.isArray(rollupOutput) ? rollupOutput[0]?.dir : rollupOutput?.dir;
+          if (dir) {
+            serverOutputDir = dir;
+          }
+        }
+      } else if (hasPlugin('cloudflare') || hasPlugin('netlify')) {
         serverOutputDir = path.resolve(resolvedConfig.root, 'dist', 'server');
+      } else {
+        consoleSandbox(() => {
+          // eslint-disable-next-line no-console
+          console.warn(
+            '[Sentry TanStack Start] Could not determine server output directory. ' +
+              'Could not detect nitro, cloudflare, or netlify vite plugin. ' +
+              'The instrument.server.mjs file will not be copied to the build output automatically.',
+          );
+        });
       }
     },
 

packages/tanstackstart-react/test/vite/copyInstrumentationFile.test.ts

@@ -45,7 +45,7 @@ describe('makeCopyInstrumentationFilePlugin()', () => {
     it('detects Nitro environment and reads output dir', () => {
       const resolvedConfig = {
         root: '/project',
-        plugins: [],
+        plugins: [{ name: 'nitro' }],
         environments: {
           nitro: {
             build: {
@@ -71,7 +71,7 @@ describe('makeCopyInstrumentationFilePlugin()', () => {
     it('detects Nitro environment with array rollup output', () => {
       const resolvedConfig = {
         root: '/project',
-        plugins: [],
+        plugins: [{ name: 'nitro' }],
         environments: {
           nitro: {
             build: {
@@ -94,7 +94,7 @@ describe('makeCopyInstrumentationFilePlugin()', () => {
     it('detects Cloudflare plugin and sets dist/server as output dir', () => {
       const resolvedConfig = {
         root: '/project',
-        plugins: [{ name: 'vite-plugin-cloudflare' }],
+        plugins: [{ name: 'cloudflare' }],
       } as unknown as ResolvedConfig;
 
       (plugin.configResolved as AnyFunction)(resolvedConfig);
@@ -108,7 +108,7 @@ describe('makeCopyInstrumentationFilePlugin()', () => {
     it('detects Netlify plugin and sets dist/server as output dir', () => {
       const resolvedConfig = {
         root: '/project',
-        plugins: [{ name: 'netlify-plugin' }],
+        plugins: [{ name: 'netlify' }],
       } as unknown as ResolvedConfig;
 
       (plugin.configResolved as AnyFunction)(resolvedConfig);
@@ -125,19 +125,42 @@ describe('makeCopyInstrumentationFilePlugin()', () => {
         plugins: [{ name: 'some-other-plugin' }],
       } as unknown as ResolvedConfig;
 
+      const warnSpy = vi.spyOn(console, 'warn').mockImplementation(() => {});
+
       (plugin.configResolved as AnyFunction)(resolvedConfig);
 
       (plugin.closeBundle as AnyFunction)();
 
       expect(fs.promises.access).not.toHaveBeenCalled();
+
+      warnSpy.mockRestore();
+    });
+
+    it('logs a warning when no recognized deployment plugin is detected', () => {
+      const resolvedConfig = {
+        root: '/project',
+        plugins: [{ name: 'some-other-plugin' }],
+      } as unknown as ResolvedConfig;
+
+      const warnSpy = vi.spyOn(console, 'warn').mockImplementation(() => {});
+
+      (plugin.configResolved as AnyFunction)(resolvedConfig);
+
+      expect(warnSpy).toHaveBeenCalledWith(
+        '[Sentry TanStack Start] Could not determine server output directory. ' +
+          'Could not detect nitro, cloudflare, or netlify vite plugin. ' +
+          'The instrument.server.mjs file will not be copied to the build output automatically.',
+      );
+
+      warnSpy.mockRestore();
     });
   });
 
   describe('closeBundle', () => {
     it('copies instrumentation file when it exists and output dir is set', async () => {
       const resolvedConfig = {
         root: '/project',
-        plugins: [],
+        plugins: [{ name: 'nitro' }],
         environments: {
           nitro: {
             build: {
@@ -176,18 +199,22 @@ describe('makeCopyInstrumentationFilePlugin()', () => {
         plugins: [{ name: 'some-other-plugin' }],
       } as unknown as ResolvedConfig;
 
+      const warnSpy = vi.spyOn(console, 'warn').mockImplementation(() => {});
+
       (plugin.configResolved as AnyFunction)(resolvedConfig);
 
       await (plugin.closeBundle as AnyFunction)();
 
       expect(fs.promises.access).not.toHaveBeenCalled();
       expect(fs.promises.copyFile).not.toHaveBeenCalled();
+
+      warnSpy.mockRestore();
     });
 
     it('does nothing when instrumentation file does not exist', async () => {
       const resolvedConfig = {
         root: '/project',
-        plugins: [],
+        plugins: [{ name: 'nitro' }],
         environments: {
           nitro: {
             build: {
@@ -214,7 +241,7 @@ describe('makeCopyInstrumentationFilePlugin()', () => {
     it('logs a warning when copy fails', async () => {
       const resolvedConfig = {
         root: '/project',
-        plugins: [],
+        plugins: [{ name: 'nitro' }],
         environments: {
           nitro: {
             build: {