@docusaurus/core 4.0.0-canary-6842 → 4.0.0-canary-6843

package/lib/server/configValidation.js

@@ -53,7 +53,6 @@ exports.DEFAULT_FASTER_CONFIG = {
     mdxCrossCompilerCache: false,
     rspackBundler: false,
     rspackPersistentCache: false,
-    ssgWorkerThreads: false,
     gitEagerVcs: false,
 };
 // When using the "faster: true" shortcut
@@ -65,7 +64,6 @@ exports.DEFAULT_FASTER_CONFIG_TRUE = {
     mdxCrossCompilerCache: true,
     rspackBundler: true,
     rspackPersistentCache: true,
-    ssgWorkerThreads: true,
     gitEagerVcs: true,
 };
 exports.DEFAULT_FUTURE_V4_CONFIG = {
@@ -217,7 +215,6 @@ const FASTER_CONFIG_SCHEMA = utils_validation_1.Joi.alternatives()
     mdxCrossCompilerCache: utils_validation_1.Joi.boolean(),
     rspackBundler: utils_validation_1.Joi.boolean(),
     rspackPersistentCache: utils_validation_1.Joi.boolean(),
-    ssgWorkerThreads: utils_validation_1.Joi.boolean(),
     gitEagerVcs: utils_validation_1.Joi.boolean(),
 }), utils_validation_1.Joi.boolean()
     .required()

package/lib/ssg/ssgExecutor.js

@@ -18,23 +18,6 @@ const ssgTemplate_1 = require("./ssgTemplate");
 const ssgEnv_1 = require("./ssgEnv");
 const ssgUtils_1 = require("./ssgUtils");
 const ssgGlobalResult_1 = require("./ssgGlobalResult");
-const ssgWorkerInline_1 = require("./ssgWorkerInline");
-const createSimpleSSGExecutor = async ({ params, pathnames, }) => {
-    return {
-        run: () => {
-            return logger_1.PerfLogger.async('SSG (current thread)', async () => {
-                const ssgResults = await (0, ssgWorkerInline_1.executeSSGInlineTask)({
-                    pathnames,
-                    params,
-                });
-                return (0, ssgGlobalResult_1.createGlobalSSGResult)(ssgResults);
-            });
-        },
-        destroy: async () => {
-            // nothing to do
-        },
-    };
-};
 // Sensible default that gives decent performances
 // It's hard to have a perfect formula that works for all hosts
 // Each thread has some creation overhead
@@ -75,15 +58,10 @@ function getWorkerColorEnv() {
     }
     return {};
 }
-const createPooledSSGExecutor = async ({ params, pathnames, }) => {
+// SSG always runs in worker threads, even for small sites
+// This isolates the server bundle execution from the main Docusaurus process
+async function createSSGExecutor({ params, pathnames, }) {
     const numberOfThreads = getNumberOfThreads(pathnames);
-    // When the inferred or provided number of threads is just 1
-    // It's not worth it to use a thread pool
-    // This also allows users to disable the thread pool with the env variable
-    // DOCUSAURUS_SSG_WORKER_THREADS=1
-    if (numberOfThreads === 1) {
-        return createSimpleSSGExecutor({ params, pathnames });
-    }
     const pool = await logger_1.PerfLogger.async(`Create SSG thread pool - ${logger_1.default.cyan(numberOfThreads)} threads`, async () => {
         const Tinypool = await import('tinypool').then((m) => m.default);
         const workerURL = (0, node_url_1.pathToFileURL)(path.resolve(__dirname, 'ssgWorkerThread.js'));
@@ -138,7 +116,7 @@ const createPooledSSGExecutor = async ({ params, pathnames, }) => {
             await pool.destroy();
         },
     };
-};
+}
 async function executeSSG({ props, serverBundlePath, clientManifestPath, router, }) {
     const params = await (0, ssgParams_1.createSSGParams)({
         serverBundlePath,
@@ -153,10 +131,10 @@ async function executeSSG({ props, serverBundlePath, clientManifestPath, router,
         logger_1.PerfLogger.end('Generate Hash Router entry point');
         return { collectedData: {} };
     }
-    const createExecutor = props.siteConfig.future.faster.ssgWorkerThreads
-        ? createPooledSSGExecutor
-        : createSimpleSSGExecutor;
-    const executor = await createExecutor({ params, pathnames: props.routesPaths });
+    const executor = await createSSGExecutor({
+        params,
+        pathnames: props.routesPaths,
+    });
     const result = await executor.run();
     await executor.destroy();
     return result;

package/lib/ssg/ssgRenderer.d.ts

@@ -21,7 +21,6 @@ export type SSGError = {
 };
 export type SSGResult = SSGSuccess | SSGError;
 export type SSGRenderer = {
-    shutdown: () => Promise<void>;
     renderPathnames: (pathnames: string[]) => Promise<SSGResult[]>;
 };
 export declare function loadSSGRenderer({ params, }: {

package/lib/ssg/ssgRenderer.js

@@ -8,46 +8,33 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.loadSSGRenderer = loadSSGRenderer;
 const tslib_1 = require("tslib");
-const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
+const module_1 = require("module");
 const path_1 = tslib_1.__importDefault(require("path"));
-// TODO eval is archived / unmaintained: https://github.com/pierrec/node-eval
-//  We should internalize/modernize it
-const eval_1 = tslib_1.__importDefault(require("eval"));
+const vm_1 = require("vm");
+const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
 const p_map_1 = tslib_1.__importDefault(require("p-map"));
 const logger_1 = tslib_1.__importStar(require("@docusaurus/logger"));
 const bundler_1 = require("@docusaurus/bundler");
 const ssgTemplate_1 = require("./ssgTemplate");
 const ssgEnv_1 = require("./ssgEnv");
 const ssgUtils_1 = require("./ssgUtils");
-const ssgNodeRequire_1 = require("./ssgNodeRequire");
+// Evaluates the server bundle as a CommonJS module, like Node.js would do
+// We don't use an isolated vm context on purpose: SSG runs in worker threads
+// that already isolate it from the main Docusaurus process
+// Running in the current context is faster and avoids reading all the globals
+function evaluateServerBundle({ source, serverBundlePath, }) {
+    const moduleFunction = (0, vm_1.compileFunction)(source, ['exports', 'require', 'module', '__filename', '__dirname'], { filename: serverBundlePath });
+    const module = { exports: {} };
+    moduleFunction.call(module.exports, module.exports, (0, module_1.createRequire)(serverBundlePath), module, serverBundlePath, path_1.default.dirname(serverBundlePath));
+    return module.exports;
+}
 async function loadAppRenderer({ serverBundlePath, }) {
-    const source = await logger_1.PerfLogger.async(`Load server bundle`, () => fs_extra_1.default.readFile(serverBundlePath));
-    const filename = path_1.default.basename(serverBundlePath);
-    const ssgRequire = (0, ssgNodeRequire_1.createSSGRequire)(serverBundlePath);
-    const globals = {
-        // When using "new URL('file.js', import.meta.url)", Webpack will emit
-        // __filename, and this plugin will throw. not sure the __filename value
-        // has any importance for this plugin, just using an empty string to
-        // avoid the error. See https://github.com/facebook/docusaurus/issues/4922
-        __filename: '',
-        // This uses module.createRequire() instead of very old "require-like" lib
-        // See also: https://github.com/pierrec/node-eval/issues/33
-        require: ssgRequire.require,
-    };
-    const serverEntry = await logger_1.PerfLogger.async(`Evaluate server bundle`, () => (0, eval_1.default)(source, 
-    /* filename: */ filename, 
-    /* scope: */ globals, 
-    /* includeGlobals: */ true));
+    const source = await logger_1.PerfLogger.async(`Load server bundle`, () => fs_extra_1.default.readFile(serverBundlePath, 'utf8'));
+    const serverEntry = await logger_1.PerfLogger.async(`Evaluate server bundle`, () => evaluateServerBundle({ source, serverBundlePath }));
     if (!serverEntry?.default || typeof serverEntry.default !== 'function') {
-        throw new Error(`Docusaurus Bug: server bundle export from "${filename}" must be a function that renders the Docusaurus React app, not ${typeof serverEntry?.default}`);
+        throw new Error(`Docusaurus Bug: server bundle export from "${serverBundlePath}" must be a function that renders the Docusaurus React app, not ${typeof serverEntry?.default}`);
     }
-    async function shutdown() {
-        ssgRequire.cleanup();
-    }
-    return {
-        render: serverEntry.default,
-        shutdown,
-    };
+    return { render: serverEntry.default };
 }
 async function loadSSGRenderer({ params, }) {
     const [appRenderer, htmlMinifier, ssgTemplate] = await Promise.all([
@@ -69,9 +56,6 @@ async function loadSSGRenderer({ params, }) {
                 ssgTemplate,
             }), { concurrency: ssgEnv_1.SSGConcurrency });
         },
-        shutdown: async () => {
-            await appRenderer.shutdown();
-        },
     };
 }
 // We reduce the page collected data structure after the HTML file is written

package/lib/ssg/ssgWorkerThread.js

@@ -20,6 +20,12 @@ if (!params) {
     throw new Error(`SSG Worker Thread workerData params missing`);
 }
 const WorkerLogPrefix = `SSG Worker ${logger_1.default.name(workerId)}`;
+// The server bundle runs in the worker thread global context
+// Web Storage should not be available during SSG, like it was before Node 25
+// Reading it emits a warning on Node 25+ unless --localstorage-file is used
+// Deleting it only affects this worker thread, not the main thread
+Reflect.deleteProperty(globalThis, 'localStorage');
+Reflect.deleteProperty(globalThis, 'sessionStorage');
 // We only load once the SSG rendered (expensive), NOT once per worker task
 // TODO check potential memory leak?
 const appRendererPromise = logger_1.PerfLogger.async(`${WorkerLogPrefix} - Initialization`, () => (0, ssgRenderer_js_1.loadSSGRenderer)({
@@ -28,8 +34,5 @@ const appRendererPromise = logger_1.PerfLogger.async(`${WorkerLogPrefix} - Initi
 async function executeSSGWorkerThreadTask(task) {
     const appRenderer = await appRendererPromise;
     const ssgResults = await logger_1.PerfLogger.async(`${WorkerLogPrefix} - Task ${logger_1.default.name(task.id)} - Rendering ${logger_1.default.cyan(task.pathnames.length)} pathnames`, () => appRenderer.renderPathnames(task.pathnames));
-    // Afaik it's not needed to shutdown here,
-    // The thread pool destroys worker thread and releases worker thread memory
-    // await appRenderer.shutdown();
     return ssgResults;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/core",
   "description": "Easy to Maintain Open Source Documentation Websites",
-  "version": "4.0.0-canary-6842",
+  "version": "4.0.0-canary-6843",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -33,14 +33,14 @@
     "url": "https://github.com/facebook/docusaurus/issues"
   },
   "dependencies": {
-    "@docusaurus/babel": "4.0.0-canary-6842",
-    "@docusaurus/bundler": "4.0.0-canary-6842",
-    "@docusaurus/glob": "4.0.0-canary-6842",
-    "@docusaurus/logger": "4.0.0-canary-6842",
-    "@docusaurus/mdx-loader": "4.0.0-canary-6842",
-    "@docusaurus/utils": "4.0.0-canary-6842",
-    "@docusaurus/utils-common": "4.0.0-canary-6842",
-    "@docusaurus/utils-validation": "4.0.0-canary-6842",
+    "@docusaurus/babel": "4.0.0-canary-6843",
+    "@docusaurus/bundler": "4.0.0-canary-6843",
+    "@docusaurus/glob": "4.0.0-canary-6843",
+    "@docusaurus/logger": "4.0.0-canary-6843",
+    "@docusaurus/mdx-loader": "4.0.0-canary-6843",
+    "@docusaurus/utils": "4.0.0-canary-6843",
+    "@docusaurus/utils-common": "4.0.0-canary-6843",
+    "@docusaurus/utils-validation": "4.0.0-canary-6843",
     "boxen": "^8.0.1",
     "cli-table3": "^0.6.5",
     "combine-promises": "^1.2.0",
@@ -49,7 +49,6 @@
     "detect-port": "^2.1.0",
     "escape-html": "^1.0.3",
     "eta": "^4.6.0",
-    "eval": "^0.1.8",
     "execa": "^10.0.1",
     "fs-extra": "^11.4.0",
     "html-tags": "^5.1.0",
@@ -76,8 +75,8 @@
     "webpack-merge": "^6.0.1"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "4.0.0-canary-6842",
-    "@docusaurus/types": "4.0.0-canary-6842",
+    "@docusaurus/module-type-aliases": "4.0.0-canary-6843",
+    "@docusaurus/types": "4.0.0-canary-6843",
     "@total-typescript/shoehorn": "^0.1.2",
     "@types/escape-html": "^1.0.4",
     "@types/history": "^4.7.11",
@@ -92,7 +91,7 @@
     "utility-types": "^3.11.0"
   },
   "peerDependencies": {
-    "@docusaurus/faster": "4.0.0-canary-6842",
+    "@docusaurus/faster": "4.0.0-canary-6843",
     "@mdx-js/react": "^3.1.1",
     "react": "^19.3.0",
     "react-dom": "^19.3.0"
@@ -105,5 +104,5 @@
   "engines": {
     "node": ">=24.21"
   },
-  "gitHead": "631fd51d00303096997d355ae6b6c525b0775c2c"
+  "gitHead": "a81a4292fc3069231904bcd6dad29ffea849e3de"
 }

package/lib/ssg/ssgNodeRequire.d.ts

@@ -1,11 +0,0 @@
-/**
- * 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.
- */
-export type SSGNodeRequire = {
-    require: NodeJS.Require;
-    cleanup: () => void;
-};
-export declare function createSSGRequire(serverBundlePath: string): SSGNodeRequire;

package/lib/ssg/ssgNodeRequire.js

@@ -1,40 +0,0 @@
-"use strict";
-/**
- * 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.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createSSGRequire = createSSGRequire;
-const module_1 = require("module");
-// The eval/vm.Script used for running the server bundle need a require() impl
-// This impl has to be relative to the server bundler path
-// This enables the server bundle to resolve relative paths such as:
-// - require('./assets/js/some-chunk.123456.js')
-//
-// Unfortunately, Node.js vm.Script doesn't isolate memory / require.cache
-// This means that if we build multiple Docusaurus localized sites in a row
-// The Node.js require cache will keep growing and retain in memory the JS
-// assets of the former SSG builds
-// We have to clean up the node require cache manually to avoid leaking memory!
-// See also https://x.com/sebastienlorber/status/1848399310116831702
-function createSSGRequire(serverBundlePath) {
-    const realRequire = (0, module_1.createRequire)(serverBundlePath);
-    const allRequiredIds = [];
-    const ssgRequireFunction = (id) => {
-        const module = realRequire(id);
-        allRequiredIds.push(id);
-        return module;
-    };
-    const cleanup = () => {
-        allRequiredIds.forEach((id) => {
-            delete realRequire.cache[realRequire.resolve(id)];
-        });
-    };
-    ssgRequireFunction.resolve = realRequire.resolve;
-    ssgRequireFunction.cache = realRequire.cache;
-    ssgRequireFunction.extensions = realRequire.extensions;
-    ssgRequireFunction.main = realRequire.main;
-    return { require: ssgRequireFunction, cleanup };
-}

package/lib/ssg/ssgWorkerInline.d.ts

@@ -1,12 +0,0 @@
-/**
- * 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 { type SSGResult } from './ssgRenderer';
-import type { SSGParams } from './ssgParams';
-export declare function executeSSGInlineTask(arg: {
-    pathnames: string[];
-    params: SSGParams;
-}): Promise<SSGResult[]>;

package/lib/ssg/ssgWorkerInline.js

@@ -1,17 +0,0 @@
-"use strict";
-/**
- * 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.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.executeSSGInlineTask = executeSSGInlineTask;
-const ssgRenderer_1 = require("./ssgRenderer");
-// "inline" means in the current thread, not in a worker
-async function executeSSGInlineTask(arg) {
-    const appRenderer = await (0, ssgRenderer_1.loadSSGRenderer)({ params: arg.params });
-    const ssgResults = appRenderer.renderPathnames(arg.pathnames);
-    await appRenderer.shutdown();
-    return ssgResults;
-}