fix: add info for banner plugin when drop_console is true (#1105)

Author: easy1090

e2e/cases/doctor-rspack/banner-plugin.test.ts

@@ -1,19 +1,29 @@
 import { expect, test } from '@playwright/test';
 import { Utils } from '@rsdoctor/core/build-utils';
 import { getSDK, setSDK } from '@rsdoctor/core/plugins';
-import { BannerPlugin, Compiler } from '@rspack/core';
+import rspack, { BannerPlugin, Compiler } from '@rspack/core';
 import { compileByRspack } from '@scripts/test-helper';
 import path from 'path';
 import { createRsdoctorPlugin } from './test-utils';
+import TerserPlugin from 'terser-webpack-plugin';
 
 let reportLoaderStartOrEndTimes = 0;
+let consoleOutput: string[] = [];
+
+// Mock console.warn to capture output
+const originalWarn = console.warn;
+console.warn = (...args: any[]) => {
+  consoleOutput.push(args.join(' '));
+  originalWarn.apply(console, args);
+};
 
 const header = `var header = 11111111; console.log(header)`;
 const footer = `var footer = 22222222; console.log(footer)`;
 
 async function rspackCompile(
   _tapName: string,
   compile: typeof compileByRspack,
+  options?: any,
 ) {
   const file = path.resolve(__dirname, './fixtures/a.js');
   const loader = path.resolve(__dirname, './fixtures/loaders/comment.js');
@@ -106,6 +116,7 @@ async function rspackCompile(
         footer: true,
       }),
     ],
+    optimization: options?.optimization,
   });
 
   return res;
@@ -135,3 +146,76 @@ test('rspack banner plugin', async () => {
   expect(res.assets[0].content).toContain('RSDOCTOR_START');
   expect(res.assets[0].content).toContain('RSDOCTOR_END');
 });
+
+test('rspack banner plugin with terser drop_console', async () => {
+  consoleOutput = []; // Reset console output
+  const tapName = 'Foo';
+  await rspackCompile(tapName, compileByRspack, {
+    optimization: {
+      minimizer: [
+        new TerserPlugin({
+          terserOptions: {
+            compress: {
+              drop_console: true,
+            },
+          },
+        }) as any,
+      ],
+    },
+  });
+
+  // Verify warning message
+  expect(
+    consoleOutput.some((msg) => msg.includes('BannerPlugin detected')),
+  ).toBe(true);
+  expect(
+    consoleOutput.some((msg) => msg.includes('disable drop_console option')),
+  ).toBe(true);
+});
+
+test('rspack banner plugin with default minimizer drop_console', async () => {
+  consoleOutput = []; // Reset console output
+  const tapName = 'Foo';
+  await rspackCompile(tapName, compileByRspack, {
+    optimization: {
+      minimizer: [
+        new rspack.SwcJsMinimizerRspackPlugin({
+          minimizerOptions: {
+            compress: {
+              drop_console: true,
+            },
+          },
+        }),
+      ],
+    },
+  });
+
+  // Verify warning message
+  expect(
+    consoleOutput.some((msg) => msg.includes('BannerPlugin detected')),
+  ).toBe(true);
+  expect(
+    consoleOutput.some((msg) => msg.includes('disable drop_console option')),
+  ).toBe(true);
+
+  const sdk = getSDK();
+  // @ts-ignore
+  const bundle = Utils.parseBundle(
+    path.join(__dirname, './fixtures/rspack-banner-plugin.js'),
+    // @ts-ignore
+    sdk.getStoreData().moduleGraph.modules,
+  );
+
+  expect(JSON.stringify(bundle.modules)).toBe(
+    '{"":{"size":313,"sizeConvert":"313 B","content":"function (\\n      __unused_webpack_module,\\n      __webpack_exports__,\\n      __webpack_require__,\\n    ) {\\n      \'use strict\';\\n      __webpack_require__.r(__webpack_exports__);\\n      __webpack_require__.d(__webpack_exports__, {\\n        a: function () {\\n          return a;\\n        },\\n      });\\n      var a = 1;\\n    }"}}',
+  );
+  const res = sdk.getStoreData().chunkGraph;
+  expect(res.assets[0].content).toContain(header);
+  expect(res.assets[0].content).toContain('RSDOCTOR_START');
+  expect(res.assets[0].content).toContain('RSDOCTOR_END');
+});
+
+// Restore console.warn after all tests
+test.afterAll(() => {
+  console.warn = originalWarn;
+});

e2e/package.json

@@ -26,6 +26,7 @@
     "@types/react": "^18.3.22",
     "loader-utils": "^2.0.4",
     "playwright": "1.44.1",
+    "terser-webpack-plugin": "^5.3.14",
     "typescript": "^5.2.2",
     "webpack": "^5.97.1"
   }

packages/core/src/inner-plugins/plugins/bundleTagPlugin.ts

@@ -34,6 +34,34 @@ export class InternalBundleTagPlugin<
               ),
             );
 
+            // Check minimizers's drop_console configuration
+            const minimizers = compiler.options.optimization?.minimizer || [];
+            const terserPlugin = minimizers.find(
+              (plugin): boolean => plugin?.constructor?.name === 'TerserPlugin',
+            ) as any;
+            const swcPlugin = minimizers.find(
+              (plugin): boolean =>
+                plugin?.constructor?.name === 'SwcJsMinimizerRspackPlugin',
+            ) as any;
+
+            const hasTerserPlugin = !!terserPlugin;
+            const hasSwcJsMinimizer = !!swcPlugin;
+
+            if (hasTerserPlugin || hasSwcJsMinimizer) {
+              const terserDropConsole =
+                terserPlugin?.options?.minimizer?.options?.compress
+                  ?.drop_console;
+              const swcDropConsole =
+                swcPlugin?._args?.[0]?.minimizerOptions?.compress?.drop_console;
+
+              if (terserDropConsole === true || swcDropConsole === true) {
+                logger.warn(
+                  chalk.yellow(
+                    'Warning: BannerPlugin detected in project. Please disable drop_console option in TerserPlugin or SwcJsMinimizerRspackPlugin to enable Rsdoctor analysis for BannerPlugin.',
+                  ),
+                );
+              }
+            }
             const chunks = compilation.chunks;
             for (let chunk of chunks) {
               for (const file of chunk.files) {