cleanup BundlerCPUProfilerPlugin

Author: slorber

.gitignore

@@ -47,4 +47,4 @@ website/i18n/**/*
 .netlify
 
 website/rspack-tracing.json
-website/rspack-cpu-profile.json
+website/bundler-cpu-profile.json

package.json

@@ -15,15 +15,15 @@
   "scripts": {
     "start": "yarn build:packages && yarn start:website",
     "start:website": "yarn workspace website start",
-    "start:website:profile": "DOCUSAURUS_RSPACK_JS_PROFILE=true DOCUSAURUS_RSPACK_TRACE=true yarn workspace website start",
+    "start:website:profile": "DOCUSAURUS_BUNDLER_CPU_PROFILE=true DOCUSAURUS_RSPACK_TRACE=true yarn workspace website start",
     "start:website:baseUrl": "yarn workspace website start:baseUrl",
     "start:website:blogOnly": "yarn workspace website start:blogOnly",
     "start:website:deployPreview": "cross-env NETLIFY=true CONTEXT='deploy-preview' yarn workspace website start",
     "examples:generate": "node admin/scripts/generateExamples.js",
     "build": "yarn build:packages && yarn build:website",
     "build:packages": "lerna run build --no-private",
     "build:website": "yarn workspace website build",
-    "build:website:profile": "DOCUSAURUS_RSPACK_JS_PROFILE=true DOCUSAURUS_RSPACK_TRACE=true yarn workspace website build",
+    "build:website:profile": "DOCUSAURUS_BUNDLER_CPU_PROFILE=true DOCUSAURUS_RSPACK_TRACE=true yarn workspace website build",
     "build:website:baseUrl": "yarn workspace website build:baseUrl",
     "build:website:blogOnly": "yarn workspace website build:blogOnly",
     "build:website:deployPreview:testWrap": "yarn workspace website test:swizzle:wrap:ts",

packages/docusaurus/src/webpack/base.ts

@@ -7,17 +7,17 @@
 
 import fs from 'fs-extra';
 import path from 'path';
-import inspector from 'node:inspector';
 import {getCustomBabelConfigFilePath} from '@docusaurus/babel';
 import {
+  createJsLoaderFactory,
   getCSSExtractPlugin,
   getMinimizers,
-  createJsLoaderFactory,
 } from '@docusaurus/bundler';
 
-import {md5Hash, getFileLoaderUtils} from '@docusaurus/utils';
-import {loadThemeAliases, loadDocusaurusAliases} from './aliases';
-import type {Configuration, Compiler} from 'webpack';
+import {getFileLoaderUtils, md5Hash} from '@docusaurus/utils';
+import {loadDocusaurusAliases, loadThemeAliases} from './aliases';
+import {BundlerCPUProfilerPlugin} from './plugins/BundlerCPUProfilerPlugin';
+import type {Configuration} from 'webpack';
 import type {
   ConfigureWebpackUtils,
   FasterConfig,
@@ -340,41 +340,8 @@ export async function createBaseConfig({
         // for more reasoning
         ignoreOrder: true,
       }),
-      process.env.DOCUSAURUS_RSPACK_JS_PROFILE &&
-        new RspackProfileJSCPUProfilePlugin(),
+      process.env.DOCUSAURUS_BUNDLER_CPU_PROFILE &&
+        new BundlerCPUProfilerPlugin(),
     ].filter(Boolean),
   };
 }
-
-// Bundle CPU profiling plugin contributed by the Rspack team
-// Can be opened in https://www.speedscope.app/
-// See also https://github.com/jerrykingxyz/docusaurus/pull/1
-// See also https://github.com/facebook/docusaurus/pull/10985
-class RspackProfileJSCPUProfilePlugin {
-  output: string;
-  constructor(output?: string) {
-    this.output = output ?? './rspack-cpu-profile.json';
-  }
-
-  apply(compiler: Compiler) {
-    const session = new inspector.Session();
-    session.connect();
-    session.post('Profiler.enable');
-    session.post('Profiler.start');
-    compiler.hooks.done.tapAsync(
-      RspackProfileJSCPUProfilePlugin.name,
-      (_stats, callback) => {
-        session.post('Profiler.stop', (error, param) => {
-          if (error) {
-            console.error('Failed to generate JS CPU profile:', error);
-            return;
-          }
-          fs.writeFile(this.output, JSON.stringify(param.profile)).catch(
-            console.error,
-          );
-        });
-        return callback();
-      },
-    );
-  }
-}

packages/docusaurus/src/webpack/plugins/BundlerCPUProfilerPlugin.ts

@@ -0,0 +1,49 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import inspector from 'node:inspector';
+import fs from 'fs-extra';
+import type {Compiler} from 'webpack';
+
+// Bundle CPU profiling plugin, contributed by the Rspack team
+// Can be opened in https://www.speedscope.app/
+// See also https://github.com/jerrykingxyz/docusaurus/pull/1
+// See also https://github.com/facebook/docusaurus/pull/10985
+export class BundlerCPUProfilerPlugin {
+  output: string;
+
+  constructor(output?: string) {
+    this.output = output ?? './bundler-cpu-profile.json';
+  }
+
+  apply(compiler: Compiler): void {
+    const session = new inspector.Session();
+    session.connect();
+    session.post('Profiler.enable');
+    session.post('Profiler.start');
+
+    // In dev/watch mode, we restart the profiler before each compilation
+    compiler.hooks.watchRun.tapPromise(
+      BundlerCPUProfilerPlugin.name,
+      async () => {
+        session.post('Profiler.start');
+      },
+    );
+
+    compiler.hooks.done.tapPromise(BundlerCPUProfilerPlugin.name, async () => {
+      session.post('Profiler.stop', (error, param) => {
+        if (error) {
+          console.error('Failed to generate JS CPU profile:', error);
+          return;
+        }
+        fs.writeFile(this.output, JSON.stringify(param.profile)).catch(
+          console.error,
+        );
+      });
+    });
+  }
+}