tests: update Sentry options structure to use webpack namespace and add deprecation warnings for top-level options

Author: logaretm

packages/nextjs/test/config/getBuildPluginOptions.test.ts

@@ -129,7 +129,9 @@ describe('getBuildPluginOptions', () => {
       const result = getBuildPluginOptions({
         sentryBuildOptions: {
           ...baseSentryOptions,
-          widenClientFileUpload: true,
+          webpack: {
+            widenClientFileUpload: true,
+          },
         },
         releaseName: mockReleaseName,
         distDirAbsPath: mockDistDirAbsPath,
@@ -573,13 +575,15 @@ describe('getBuildPluginOptions', () => {
           create: true,
           vcsRemote: 'origin',
         },
-        unstable_sentryWebpackPluginOptions: {
-          release: {
-            setCommits: {
-              auto: true,
-            },
-            deploy: {
-              env: 'production',
+        webpack: {
+          unstable_sentryWebpackPluginOptions: {
+            release: {
+              setCommits: {
+                auto: true,
+              },
+              deploy: {
+                env: 'production',
+              },
             },
           },
         },
@@ -592,7 +596,7 @@ describe('getBuildPluginOptions', () => {
         buildTool: 'webpack-client',
       });
 
-      // The unstable_sentryWebpackPluginOptions.release is spread at the end and may override base properties
+      // The webpack.unstable_sentryWebpackPluginOptions.release is spread at the end and may override base properties
       expect(result.release).toHaveProperty('setCommits.auto', true);
       expect(result.release).toHaveProperty('deploy.env', 'production');
     });
@@ -603,12 +607,14 @@ describe('getBuildPluginOptions', () => {
       const sentryBuildOptions: SentryBuildOptions = {
         org: 'test-org',
         project: 'test-project',
-        reactComponentAnnotation: {
-          enabled: true,
-        },
-        unstable_sentryWebpackPluginOptions: {
+        webpack: {
           reactComponentAnnotation: {
-            enabled: false, // This will override the base setting
+            enabled: true,
+          },
+          unstable_sentryWebpackPluginOptions: {
+            reactComponentAnnotation: {
+              enabled: false, // This will override the base setting
+            },
           },
         },
       };
@@ -695,10 +701,12 @@ describe('getBuildPluginOptions', () => {
       const sentryBuildOptions: SentryBuildOptions = {
         org: 'test-org',
         project: 'test-project',
-        unstable_sentryWebpackPluginOptions: {
-          applicationKey: 'test-app-key',
-          sourcemaps: {
-            disable: false,
+        webpack: {
+          unstable_sentryWebpackPluginOptions: {
+            applicationKey: 'test-app-key',
+            sourcemaps: {
+              disable: false,
+            },
           },
         },
       };

packages/nextjs/test/config/withSentryConfig.test.ts

@@ -359,6 +359,103 @@ describe('withSentryConfig', () => {
         expect(finalConfigOld.webpack).toBeInstanceOf(Function);
       });
     });
+
+    describe('deprecation warnings', () => {
+      let consoleWarnSpy: ReturnType<typeof vi.spyOn>;
+
+      beforeEach(() => {
+        consoleWarnSpy = vi.spyOn(console, 'warn').mockImplementation(() => {});
+      });
+
+      afterEach(() => {
+        consoleWarnSpy.mockRestore();
+        delete process.env.TURBOPACK;
+        vi.restoreAllMocks();
+      });
+
+      it('warns when using deprecated top-level options', () => {
+        delete process.env.TURBOPACK;
+
+        const sentryOptions = {
+          disableLogger: true,
+          widenClientFileUpload: true,
+        };
+
+        materializeFinalNextConfig(exportedNextConfig, undefined, sentryOptions);
+
+        expect(consoleWarnSpy).toHaveBeenCalledWith(
+          expect.stringContaining('[@sentry/nextjs] DEPRECATION WARNING: disableLogger is deprecated'),
+        );
+        expect(consoleWarnSpy).toHaveBeenCalledWith(expect.stringContaining('Use webpack.treeshake.debugLogs instead'));
+        expect(consoleWarnSpy).toHaveBeenCalledWith(
+          expect.stringContaining('[@sentry/nextjs] DEPRECATION WARNING: widenClientFileUpload is deprecated'),
+        );
+        expect(consoleWarnSpy).toHaveBeenCalledWith(
+          expect.stringContaining('Use webpack.widenClientFileUpload instead'),
+        );
+      });
+
+      it('does not warn when using new webpack path', () => {
+        delete process.env.TURBOPACK;
+
+        const sentryOptions = {
+          webpack: {
+            treeshake: {
+              debugLogs: true,
+            },
+            widenClientFileUpload: true,
+          },
+        };
+
+        materializeFinalNextConfig(exportedNextConfig, undefined, sentryOptions);
+
+        expect(consoleWarnSpy).not.toHaveBeenCalled();
+      });
+
+      it('warns even when new path is also set', () => {
+        delete process.env.TURBOPACK;
+
+        const sentryOptions = {
+          disableLogger: true, // deprecated
+          webpack: {
+            treeshake: {
+              debugLogs: false, // new path takes precedence
+            },
+          },
+        };
+
+        materializeFinalNextConfig(exportedNextConfig, undefined, sentryOptions);
+
+        // Should warn because deprecated value is present
+        expect(consoleWarnSpy).toHaveBeenCalledWith(
+          expect.stringContaining('[@sentry/nextjs] DEPRECATION WARNING: disableLogger is deprecated'),
+        );
+      });
+
+      it('warns for multiple deprecated options at once', () => {
+        delete process.env.TURBOPACK;
+
+        const sentryOptions = {
+          disableLogger: true,
+          automaticVercelMonitors: false,
+          excludeServerRoutes: ['/api/test'],
+        };
+
+        materializeFinalNextConfig(exportedNextConfig, undefined, sentryOptions);
+
+        // Should warn for all three deprecated options
+        expect(consoleWarnSpy).toHaveBeenCalledWith(
+          expect.stringContaining('[@sentry/nextjs] DEPRECATION WARNING: disableLogger is deprecated'),
+        );
+        expect(consoleWarnSpy).toHaveBeenCalledWith(
+          expect.stringContaining('[@sentry/nextjs] DEPRECATION WARNING: automaticVercelMonitors is deprecated'),
+        );
+        expect(consoleWarnSpy).toHaveBeenCalledWith(
+          expect.stringContaining('[@sentry/nextjs] DEPRECATION WARNING: excludeServerRoutes is deprecated'),
+        );
+        expect(consoleWarnSpy).toHaveBeenCalledTimes(3);
+      });
+    });
   });
 
   describe('bundler detection', () => {