@docusaurus/core 3.7.0-canary-6200 → 3.7.0-canary-6204

package/lib/client/serverEntry.js

@@ -12,7 +12,8 @@ import { renderToHtml } from './renderToHtml';
 import preload from './preload';
 import App from './App';
 import { createStatefulBrokenLinks, BrokenLinksProvider, } from './BrokenLinksContext';
-const render = async ({ pathname }) => {
+import { toPageCollectedMetadata } from './serverHelmetUtils';
+const render = async ({ pathname, v4RemoveLegacyPostBuildHeadAttribute, }) => {
     await preload(pathname);
     const modules = new Set();
     const routerContext = {};
@@ -30,10 +31,15 @@ const render = async ({ pathname }) => {
       </HelmetProvider>
     </Loadable.Capture>);
     const html = await renderToHtml(app);
+    const { helmet } = helmetContext;
+    const metadata = toPageCollectedMetadata({ helmet });
+    // TODO Docusaurus v4 remove with deprecated postBuild({head}) API
+    //  the returned collectedData must be serializable to run in workers
+    if (v4RemoveLegacyPostBuildHeadAttribute) {
+        metadata.helmet = null;
+    }
     const collectedData = {
-        // TODO Docusaurus v4 refactor: helmet state is non-serializable
-        //  this makes it impossible to run SSG in a worker thread
-        helmet: helmetContext.helmet,
+        metadata,
         anchors: statefulBrokenLinks.getCollectedAnchors(),
         links: statefulBrokenLinks.getCollectedLinks(),
         modules: Array.from(modules),

package/lib/client/serverHelmetUtils.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 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 { PageCollectedMetadata } from '../common';
+import type { HelmetServerState } from 'react-helmet-async';
+export declare function toPageCollectedMetadata({ helmet, }: {
+    helmet: HelmetServerState;
+}): PageCollectedMetadata;

package/lib/client/serverHelmetUtils.js

@@ -0,0 +1,39 @@
+/**
+ * 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.
+ */
+function getBuildMetaTags(helmet) {
+    // @ts-expect-error: see  https://github.com/staylor/react-helmet-async/pull/167
+    const metaElements = helmet.meta.toComponent() ?? [];
+    return metaElements.map((el) => el.props);
+}
+function isNoIndexTag(tag) {
+    if (!tag.name || !tag.content) {
+        return false;
+    }
+    return (
+    // meta name is not case-sensitive
+    tag.name.toLowerCase() === 'robots' &&
+        // Robots directives are not case-sensitive
+        tag.content.toLowerCase().includes('noindex'));
+}
+export function toPageCollectedMetadata({ helmet, }) {
+    const tags = getBuildMetaTags(helmet);
+    const noIndex = tags.some(isNoIndexTag);
+    return {
+        helmet, // TODO Docusaurus v4 remove
+        public: {
+            noIndex,
+        },
+        internal: {
+            htmlAttributes: helmet.htmlAttributes.toString(),
+            bodyAttributes: helmet.bodyAttributes.toString(),
+            title: helmet.title.toString(),
+            meta: helmet.meta.toString(),
+            link: helmet.link.toString(),
+            script: helmet.script.toString(),
+        },
+    };
+}

package/lib/commands/build/buildLocale.js

@@ -71,7 +71,10 @@ async function buildLocale({ siteDir, locale, cliOptions, }) {
     logger_1.default.success `Generated static files in path=${path_1.default.relative(process.cwd(), outDir)}.`;
 }
 async function executePluginsPostBuild({ plugins, props, collectedData, }) {
-    const head = lodash_1.default.mapValues(collectedData, (d) => d.helmet);
+    const head = props.siteConfig.future.v4.removeLegacyPostBuildHeadAttribute
+        ? {}
+        : lodash_1.default.mapValues(collectedData, (d) => d.metadata.helmet);
+    const routesBuildMetadata = lodash_1.default.mapValues(collectedData, (d) => d.metadata.public);
     await Promise.all(plugins.map(async (plugin) => {
         if (!plugin.postBuild) {
             return;
@@ -79,6 +82,7 @@ async function executePluginsPostBuild({ plugins, props, collectedData, }) {
         await plugin.postBuild({
             ...props,
             head,
+            routesBuildMetadata,
             content: plugin.content,
         });
     }));

package/lib/server/configValidation.d.ts

@@ -5,12 +5,14 @@
  * LICENSE file in the root directory of this source tree.
  */
 import { Joi } from '@docusaurus/utils-validation';
-import type { FasterConfig, FutureConfig, StorageConfig } from '@docusaurus/types/src/config';
+import type { FasterConfig, FutureConfig, FutureV4Config, StorageConfig } from '@docusaurus/types/src/config';
 import type { DocusaurusConfig, I18nConfig, MarkdownConfig } from '@docusaurus/types';
 export declare const DEFAULT_I18N_CONFIG: I18nConfig;
 export declare const DEFAULT_STORAGE_CONFIG: StorageConfig;
 export declare const DEFAULT_FASTER_CONFIG: FasterConfig;
 export declare const DEFAULT_FASTER_CONFIG_TRUE: FasterConfig;
+export declare const DEFAULT_FUTURE_V4_CONFIG: FutureV4Config;
+export declare const DEFAULT_FUTURE_V4_CONFIG_TRUE: FutureV4Config;
 export declare const DEFAULT_FUTURE_CONFIG: FutureConfig;
 export declare const DEFAULT_MARKDOWN_CONFIG: MarkdownConfig;
 export declare const DEFAULT_CONFIG: Pick<DocusaurusConfig, 'i18n' | 'future' | 'onBrokenLinks' | 'onBrokenAnchors' | 'onBrokenMarkdownLinks' | 'onDuplicateRoutes' | 'plugins' | 'themes' | 'presets' | 'headTags' | 'stylesheets' | 'scripts' | 'clientModules' | 'customFields' | 'themeConfig' | 'titleDelimiter' | 'noIndex' | 'tagline' | 'baseUrlIssueBanner' | 'staticDirectories' | 'markdown'>;

package/lib/server/configValidation.js

@@ -6,11 +6,13 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConfigSchema = exports.DEFAULT_CONFIG = exports.DEFAULT_MARKDOWN_CONFIG = exports.DEFAULT_FUTURE_CONFIG = exports.DEFAULT_FASTER_CONFIG_TRUE = exports.DEFAULT_FASTER_CONFIG = exports.DEFAULT_STORAGE_CONFIG = exports.DEFAULT_I18N_CONFIG = void 0;
+exports.ConfigSchema = exports.DEFAULT_CONFIG = exports.DEFAULT_MARKDOWN_CONFIG = exports.DEFAULT_FUTURE_CONFIG = exports.DEFAULT_FUTURE_V4_CONFIG_TRUE = exports.DEFAULT_FUTURE_V4_CONFIG = exports.DEFAULT_FASTER_CONFIG_TRUE = exports.DEFAULT_FASTER_CONFIG = exports.DEFAULT_STORAGE_CONFIG = exports.DEFAULT_I18N_CONFIG = void 0;
 exports.validateConfig = validateConfig;
+const tslib_1 = require("tslib");
 const utils_1 = require("@docusaurus/utils");
 const utils_validation_1 = require("@docusaurus/utils-validation");
 const utils_common_1 = require("@docusaurus/utils-common");
+const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 const DEFAULT_I18N_LOCALE = 'en';
 exports.DEFAULT_I18N_CONFIG = {
     defaultLocale: DEFAULT_I18N_LOCALE,
@@ -29,6 +31,7 @@ exports.DEFAULT_FASTER_CONFIG = {
     lightningCssMinimizer: false,
     mdxCrossCompilerCache: false,
     rspackBundler: false,
+    ssgWorkerThreads: false,
 };
 // When using the "faster: true" shortcut
 exports.DEFAULT_FASTER_CONFIG_TRUE = {
@@ -38,8 +41,17 @@ exports.DEFAULT_FASTER_CONFIG_TRUE = {
     lightningCssMinimizer: true,
     mdxCrossCompilerCache: true,
     rspackBundler: true,
+    ssgWorkerThreads: true,
+};
+exports.DEFAULT_FUTURE_V4_CONFIG = {
+    removeLegacyPostBuildHeadAttribute: false,
+};
+// When using the "v4: true" shortcut
+exports.DEFAULT_FUTURE_V4_CONFIG_TRUE = {
+    removeLegacyPostBuildHeadAttribute: true,
 };
 exports.DEFAULT_FUTURE_CONFIG = {
+    v4: exports.DEFAULT_FUTURE_V4_CONFIG,
     experimental_faster: exports.DEFAULT_FASTER_CONFIG,
     experimental_storage: exports.DEFAULT_STORAGE_CONFIG,
     experimental_router: 'browser',
@@ -155,11 +167,20 @@ const FASTER_CONFIG_SCHEMA = utils_validation_1.Joi.alternatives()
     lightningCssMinimizer: utils_validation_1.Joi.boolean().default(exports.DEFAULT_FASTER_CONFIG.lightningCssMinimizer),
     mdxCrossCompilerCache: utils_validation_1.Joi.boolean().default(exports.DEFAULT_FASTER_CONFIG.mdxCrossCompilerCache),
     rspackBundler: utils_validation_1.Joi.boolean().default(exports.DEFAULT_FASTER_CONFIG.rspackBundler),
+    ssgWorkerThreads: utils_validation_1.Joi.boolean().default(exports.DEFAULT_FASTER_CONFIG.ssgWorkerThreads),
 }), utils_validation_1.Joi.boolean()
     .required()
     .custom((bool) => bool ? exports.DEFAULT_FASTER_CONFIG_TRUE : exports.DEFAULT_FASTER_CONFIG))
     .optional()
     .default(exports.DEFAULT_FASTER_CONFIG);
+const FUTURE_V4_SCHEMA = utils_validation_1.Joi.alternatives()
+    .try(utils_validation_1.Joi.object({
+    removeLegacyPostBuildHeadAttribute: utils_validation_1.Joi.boolean().default(exports.DEFAULT_FUTURE_V4_CONFIG.removeLegacyPostBuildHeadAttribute),
+}), utils_validation_1.Joi.boolean()
+    .required()
+    .custom((bool) => bool ? exports.DEFAULT_FUTURE_V4_CONFIG_TRUE : exports.DEFAULT_FUTURE_V4_CONFIG))
+    .optional()
+    .default(exports.DEFAULT_FUTURE_V4_CONFIG);
 const STORAGE_CONFIG_SCHEMA = utils_validation_1.Joi.object({
     type: utils_validation_1.Joi.string()
         .equal('localStorage', 'sessionStorage')
@@ -171,6 +192,7 @@ const STORAGE_CONFIG_SCHEMA = utils_validation_1.Joi.object({
     .optional()
     .default(exports.DEFAULT_STORAGE_CONFIG);
 const FUTURE_CONFIG_SCHEMA = utils_validation_1.Joi.object({
+    v4: FUTURE_V4_SCHEMA,
     experimental_faster: FASTER_CONFIG_SCHEMA,
     experimental_storage: STORAGE_CONFIG_SCHEMA,
     experimental_router: utils_validation_1.Joi.string()
@@ -308,6 +330,15 @@ exports.ConfigSchema = utils_validation_1.Joi.object({
 }).messages({
     'docusaurus.configValidationWarning': 'Docusaurus config validation warning. Field {#label}: {#warningMessage}',
 });
+// Expressing this kind of logic in Joi is a pain
+// We also want to decouple logic from Joi: easier to remove it later!
+function ensureDocusaurusConfigConsistency(config) {
+    if (config.future.experimental_faster.ssgWorkerThreads &&
+        !config.future.v4.removeLegacyPostBuildHeadAttribute) {
+        throw new Error(`Docusaurus config ${logger_1.default.code('future.experimental_faster.ssgWorkerThreads')} requires the future flag ${logger_1.default.code('future.v4.removeLegacyPostBuildHeadAttribute')} to be turned on.
+If you use Docusaurus Faster, we recommend that you also activate Docusaurus v4 future flags: ${logger_1.default.code('{future: {v4: true}}')}`);
+    }
+}
 // TODO move to @docusaurus/utils-validation
 function validateConfig(config, siteConfigPath) {
     const { error, warning, value } = exports.ConfigSchema.validate(config, {
@@ -329,7 +360,6 @@ function validateConfig(config, siteConfigPath) {
             : formattedError;
         throw new Error(formattedError);
     }
-    else {
-        return value;
-    }
+    ensureDocusaurusConfigConsistency(value);
+    return value;
 }

package/lib/ssg/ssgEnv.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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 declare const SSGConcurrency: number;
+export declare const SSGWorkerThreadCount: number | undefined;
+export declare const SSGWorkerThreadTaskSize: number;

package/lib/ssg/ssgEnv.js

@@ -0,0 +1,29 @@
+"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.SSGWorkerThreadTaskSize = exports.SSGWorkerThreadCount = exports.SSGConcurrency = void 0;
+// Secret way to set SSR plugin async concurrency option
+// Waiting for feedback before documenting this officially?
+// TODO Docusaurus v4, rename SSR => SSG
+exports.SSGConcurrency = process.env.DOCUSAURUS_SSR_CONCURRENCY
+    ? parseInt(process.env.DOCUSAURUS_SSR_CONCURRENCY, 10)
+    : // Not easy to define a reasonable option default
+        // Will still be better than Infinity
+        // See also https://github.com/sindresorhus/p-map/issues/24
+        32;
+// Secret way to set SSR plugin async concurrency option
+// Waiting for feedback before documenting this officially?
+exports.SSGWorkerThreadCount = process.env
+    .DOCUSAURUS_SSG_WORKER_THREAD_COUNT
+    ? parseInt(process.env.DOCUSAURUS_SSG_WORKER_THREAD_COUNT, 10)
+    : undefined;
+// Number of pathnames to SSG per worker task
+exports.SSGWorkerThreadTaskSize = process.env
+    .DOCUSAURUS_SSG_WORKER_THREAD_TASK_SIZE
+    ? parseInt(process.env.DOCUSAURUS_SSG_WORKER_THREAD_TASK_SIZE, 10)
+    : 10; // TODO need fine-tuning

package/lib/ssg/ssgExecutor.js

@@ -7,18 +7,109 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.executeSSG = executeSSG;
-const logger_1 = require("@docusaurus/logger");
+const tslib_1 = require("tslib");
+const path = tslib_1.__importStar(require("path"));
+const node_url_1 = require("node:url");
+const os_1 = tslib_1.__importDefault(require("os"));
+const lodash_1 = tslib_1.__importDefault(require("lodash"));
+const logger_1 = tslib_1.__importStar(require("@docusaurus/logger"));
 const ssgParams_1 = require("./ssgParams");
-const ssg_1 = require("./ssg");
 const ssgTemplate_1 = require("./ssgTemplate");
+const ssgEnv_1 = require("./ssgEnv");
 const ssgUtils_1 = require("./ssgUtils");
-// TODO Docusaurus v4 - introduce SSG worker threads
+const ssgGlobalResult_1 = require("./ssgGlobalResult");
+const ssgWorkerInline_1 = require("./ssgWorkerInline");
+const createSimpleSSGExecutor = async ({ params, pathnames, }) => {
+    return {
+        run: () => {
+            return logger_1.PerfLogger.async('Generate static files (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
+// Having 1 thread per cpu doesn't necessarily improve perf on small sites
+// We want to ensure that we don't create a worker thread for less than x paths
+function inferNumberOfThreads({ pageCount, cpuCount, minPagesPerCpu, }) {
+    // Calculate "ideal" amount of threads based on the number of pages to render
+    const threadsByWorkload = Math.ceil(pageCount / minPagesPerCpu);
+    // Use the smallest of threadsByWorkload or cpuCount, ensuring min=1 thread
+    return Math.max(1, Math.min(threadsByWorkload, cpuCount));
+}
+function getNumberOfThreads(pathnames) {
+    if (typeof ssgEnv_1.SSGWorkerThreadCount !== 'undefined') {
+        return ssgEnv_1.SSGWorkerThreadCount;
+    }
+    return inferNumberOfThreads({
+        pageCount: pathnames.length,
+        // TODO use "physical CPUs" instead of "logical CPUs" (like Tinypool does)
+        // See also https://github.com/tinylibs/tinypool/pull/108
+        cpuCount: os_1.default.cpus().length,
+        // These are "magic value" that we should refine based on user feedback
+        // Local tests show that it's not worth spawning new workers for few pages
+        minPagesPerCpu: 100,
+    });
+}
+const createPooledSSGExecutor = async ({ 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 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'));
+        return new Tinypool({
+            filename: workerURL.pathname,
+            minThreads: numberOfThreads,
+            maxThreads: numberOfThreads,
+            concurrentTasksPerWorker: 1,
+            runtime: 'worker_threads',
+            isolateWorkers: false,
+            workerData: { params },
+        });
+    });
+    const pathnamesChunks = lodash_1.default.chunk(pathnames, ssgEnv_1.SSGWorkerThreadTaskSize);
+    // Tiny wrapper for type-safety
+    const submitTask = (task) => pool.run(task);
+    return {
+        run: async () => {
+            const results = await logger_1.PerfLogger.async(`Generate static files (${numberOfThreads} worker threads)`, async () => {
+                return Promise.all(pathnamesChunks.map((taskPathnames, taskIndex) => {
+                    return submitTask({
+                        id: taskIndex + 1,
+                        pathnames: taskPathnames,
+                    });
+                }));
+            });
+            const allResults = results.flat();
+            return (0, ssgGlobalResult_1.createGlobalSSGResult)(allResults);
+        },
+        destroy: async () => {
+            await pool.destroy();
+        },
+    };
+};
 async function executeSSG({ props, serverBundlePath, clientManifestPath, router, }) {
     const params = await (0, ssgParams_1.createSSGParams)({
         serverBundlePath,
         clientManifestPath,
         props,
     });
+    // TODO doesn't look like the appropriate place for hash router entry
     if (router === 'hash') {
         logger_1.PerfLogger.start('Generate Hash Router entry point');
         const content = await (0, ssgTemplate_1.renderHashRouterTemplate)({ params });
@@ -26,9 +117,12 @@ async function executeSSG({ props, serverBundlePath, clientManifestPath, router,
         logger_1.PerfLogger.end('Generate Hash Router entry point');
         return { collectedData: {} };
     }
-    const ssgResult = await logger_1.PerfLogger.async('Generate static files', () => (0, ssg_1.generateStaticFiles)({
-        pathnames: props.routesPaths,
-        params,
-    }));
-    return ssgResult;
+    const createExecutor = props.siteConfig.future.experimental_faster
+        .ssgWorkerThreads
+        ? createPooledSSGExecutor
+        : createSimpleSSGExecutor;
+    const executor = await createExecutor({ params, pathnames: props.routesPaths });
+    const result = await executor.run();
+    await executor.destroy();
+    return result;
 }

package/lib/ssg/ssgGlobalResult.d.ts

@@ -0,0 +1,12 @@
+/**
+ * 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 { SiteCollectedData } from '../common';
+export type SSGGlobalResult = {
+    collectedData: SiteCollectedData;
+};
+export declare function createGlobalSSGResult(ssgResults: SSGResult[]): Promise<SSGGlobalResult>;

package/lib/ssg/ssgGlobalResult.js

@@ -0,0 +1,74 @@
+"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.createGlobalSSGResult = createGlobalSSGResult;
+const tslib_1 = require("tslib");
+const lodash_1 = tslib_1.__importDefault(require("lodash"));
+const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
+function printSSGWarnings(results) {
+    // Escape hatch because SWC is quite aggressive to report errors
+    // See https://github.com/facebook/docusaurus/pull/10554
+    // See https://github.com/swc-project/swc/discussions/9616#discussioncomment-10846201
+    if (process.env.DOCUSAURUS_IGNORE_SSG_WARNINGS === 'true') {
+        return;
+    }
+    const ignoredWarnings = [
+        // TODO Docusaurus v4: remove with React 19 upgrade
+        //  React 18 emit NULL chars, and minifier detects it
+        //  see https://github.com/facebook/docusaurus/issues/9985
+        'Unexpected null character',
+    ];
+    const keepWarning = (warning) => {
+        return !ignoredWarnings.some((iw) => warning.includes(iw));
+    };
+    const resultsWithWarnings = results
+        .map((success) => {
+        return {
+            ...success,
+            warnings: success.result.warnings.filter(keepWarning),
+        };
+    })
+        .filter((result) => result.warnings.length > 0);
+    if (resultsWithWarnings.length) {
+        const message = `Docusaurus static site generation process emitted warnings for ${resultsWithWarnings.length} path${resultsWithWarnings.length ? 's' : ''}
+This is non-critical and can be disabled with DOCUSAURUS_IGNORE_SSG_WARNINGS=true
+Troubleshooting guide: https://github.com/facebook/docusaurus/discussions/10580
+
+- ${resultsWithWarnings
+            .map((result) => `${logger_1.default.path(result.pathname)}:
+  - ${result.warnings.join('\n  - ')}
+`)
+            .join('\n- ')}`;
+        logger_1.default.warn(message);
+    }
+}
+function throwSSGError(ssgErrors) {
+    const message = `Docusaurus static site generation failed for ${ssgErrors.length} path${ssgErrors.length ? 's' : ''}:\n- ${ssgErrors
+        .map((ssgError) => logger_1.default.path(ssgError.pathname))
+        .join('\n- ')}`;
+    // Note logging this error properly require using inspect(error,{depth})
+    // See https://github.com/nodejs/node/issues/51637
+    throw new Error(message, {
+        cause: new AggregateError(ssgErrors.map((ssgError) => ssgError.error)),
+    });
+}
+async function createGlobalSSGResult(ssgResults) {
+    const [ssgSuccesses, ssgErrors] = lodash_1.default.partition(ssgResults, (result) => result.success);
+    // For now, only success results emit warnings
+    // For errors, we throw without warnings
+    printSSGWarnings(ssgSuccesses);
+    if (ssgErrors.length > 0) {
+        throwSSGError(ssgErrors);
+    }
+    // If we only have SSG successes, we can consolidate those in a single result
+    const collectedData = lodash_1.default.chain(ssgSuccesses)
+        .keyBy((success) => success.pathname)
+        .mapValues((ssgSuccess) => ssgSuccess.result.collectedData)
+        .value();
+    return { collectedData };
+}

package/lib/ssg/ssgParams.d.ts

@@ -20,6 +20,7 @@ export type SSGParams = {
     htmlMinifierType: HtmlMinifierType;
     serverBundlePath: string;
     ssgTemplateContent: string;
+    v4RemoveLegacyPostBuildHeadAttribute: boolean;
 };
 export declare function createSSGParams({ props, serverBundlePath, clientManifestPath, }: {
     props: Props;

package/lib/ssg/ssgParams.js

@@ -30,6 +30,7 @@ async function createSSGParams({ props, serverBundlePath, clientManifestPath, })
             .swcHtmlMinimizer
             ? 'swc'
             : 'terser',
+        v4RemoveLegacyPostBuildHeadAttribute: props.siteConfig.future.v4.removeLegacyPostBuildHeadAttribute,
     };
     // Useless but ensures that SSG params remain serializable
     return structuredClone(params);

package/lib/ssg/ssgRenderer.d.ts

@@ -0,0 +1,29 @@
+/**
+ * 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 { SSGParams } from './ssgParams';
+import type { AppRenderResult } from '../common';
+export type SSGSuccess = {
+    success: true;
+    pathname: string;
+    result: {
+        collectedData: AppRenderResult['collectedData'];
+        warnings: string[];
+    };
+};
+export type SSGError = {
+    success: false;
+    pathname: string;
+    error: Error;
+};
+export type SSGResult = SSGSuccess | SSGError;
+export type SSGRenderer = {
+    shutdown: () => Promise<void>;
+    renderPathnames: (pathnames: string[]) => Promise<SSGResult[]>;
+};
+export declare function loadSSGRenderer({ params, }: {
+    params: SSGParams;
+}): Promise<SSGRenderer>;

package/lib/ssg/{ssg.js → ssgRenderer.js}

@@ -6,13 +6,10 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadAppRenderer = loadAppRenderer;
-exports.printSSGWarnings = printSSGWarnings;
-exports.generateStaticFiles = generateStaticFiles;
+exports.loadSSGRenderer = loadSSGRenderer;
 const tslib_1 = require("tslib");
 const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
 const path_1 = tslib_1.__importDefault(require("path"));
-const lodash_1 = tslib_1.__importDefault(require("lodash"));
 // TODO eval is archived / unmaintained: https://github.com/pierrec/node-eval
 //  We should internalize/modernize it
 const eval_1 = tslib_1.__importDefault(require("eval"));
@@ -20,11 +17,11 @@ 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");
 async function loadAppRenderer({ serverBundlePath, }) {
     const source = await logger_1.PerfLogger.async(`Load server bundle`, () => fs_extra_1.default.readFile(serverBundlePath));
-    logger_1.PerfLogger.log(`Server bundle size = ${(source.length / 1024000).toFixed(3)} MB`);
     const filename = path_1.default.basename(serverBundlePath);
     const ssgRequire = (0, ssgNodeRequire_1.createSSGRequire)(serverBundlePath);
     const globals = {
@@ -52,44 +49,8 @@ async function loadAppRenderer({ serverBundlePath, }) {
         shutdown,
     };
 }
-function printSSGWarnings(results) {
-    // Escape hatch because SWC is quite aggressive to report errors
-    // See https://github.com/facebook/docusaurus/pull/10554
-    // See https://github.com/swc-project/swc/discussions/9616#discussioncomment-10846201
-    if (process.env.DOCUSAURUS_IGNORE_SSG_WARNINGS === 'true') {
-        return;
-    }
-    const ignoredWarnings = [
-        // TODO React/Docusaurus emit NULL chars, and minifier detects it
-        //  see https://github.com/facebook/docusaurus/issues/9985
-        'Unexpected null character',
-    ];
-    const keepWarning = (warning) => {
-        return !ignoredWarnings.some((iw) => warning.includes(iw));
-    };
-    const resultsWithWarnings = results
-        .map((result) => {
-        return {
-            ...result,
-            warnings: result.warnings.filter(keepWarning),
-        };
-    })
-        .filter((result) => result.warnings.length > 0);
-    if (resultsWithWarnings.length) {
-        const message = `Docusaurus static site generation process emitted warnings for ${resultsWithWarnings.length} path${resultsWithWarnings.length ? 's' : ''}
-This is non-critical and can be disabled with DOCUSAURUS_IGNORE_SSG_WARNINGS=true
-Troubleshooting guide: https://github.com/facebook/docusaurus/discussions/10580
-
-- ${resultsWithWarnings
-            .map((result) => `${logger_1.default.path(result.pathname)}:
-  - ${result.warnings.join('\n  - ')}
-`)
-            .join('\n- ')}`;
-        logger_1.default.warn(message);
-    }
-}
-async function generateStaticFiles({ pathnames, params, }) {
-    const [renderer, htmlMinifier, ssgTemplate] = await Promise.all([
+async function loadSSGRenderer({ params, }) {
+    const [appRenderer, htmlMinifier, ssgTemplate] = await Promise.all([
         logger_1.PerfLogger.async('Load App renderer', () => loadAppRenderer({
             serverBundlePath: params.serverBundlePath,
         })),
@@ -98,54 +59,32 @@ async function generateStaticFiles({ pathnames, params, }) {
         })),
         logger_1.PerfLogger.async('Compile SSG template', () => (0, ssgTemplate_1.compileSSGTemplate)(params.ssgTemplateContent)),
     ]);
-    // Note that we catch all async errors on purpose
-    // Docusaurus presents all the SSG errors to the user, not just the first one
-    const results = await (0, p_map_1.default)(pathnames, async (pathname) => generateStaticFile({
-        pathname,
-        renderer,
-        params,
-        htmlMinifier,
-        ssgTemplate,
-    }).then((result) => ({
-        pathname,
-        result,
-        error: null,
-        warnings: result.warnings,
-    }), (error) => ({
-        pathname,
-        result: null,
-        error: error,
-        warnings: [],
-    })), { concurrency: ssgUtils_1.SSGConcurrency });
-    await renderer.shutdown();
-    printSSGWarnings(results);
-    const [allSSGErrors, allSSGSuccesses] = lodash_1.default.partition(results, (result) => !!result.error);
-    if (allSSGErrors.length > 0) {
-        const message = `Docusaurus static site generation failed for ${allSSGErrors.length} path${allSSGErrors.length ? 's' : ''}:\n- ${allSSGErrors
-            .map((ssgError) => logger_1.default.path(ssgError.pathname))
-            .join('\n- ')}`;
-        // Note logging this error properly require using inspect(error,{depth})
-        // See https://github.com/nodejs/node/issues/51637
-        throw new Error(message, {
-            cause: new AggregateError(allSSGErrors.map((ssgError) => ssgError.error)),
-        });
-    }
-    const collectedData = lodash_1.default.chain(allSSGSuccesses)
-        .keyBy((success) => success.pathname)
-        .mapValues((ssgSuccess) => ssgSuccess.result.collectedData)
-        .value();
-    return { collectedData };
+    return {
+        renderPathnames: (pathnames) => {
+            return (0, p_map_1.default)(pathnames, async (pathname) => generateStaticFile({
+                pathname,
+                appRenderer,
+                params,
+                htmlMinifier,
+                ssgTemplate,
+            }), { concurrency: ssgEnv_1.SSGConcurrency });
+        },
+        shutdown: async () => {
+            await appRenderer.shutdown();
+        },
+    };
 }
-async function generateStaticFile({ pathname, renderer, params, htmlMinifier, ssgTemplate, }) {
+async function generateStaticFile({ pathname, appRenderer, params, htmlMinifier, ssgTemplate, }) {
     try {
         // This only renders the app HTML
-        const result = await renderer.render({
+        const appRenderResult = await appRenderer.render({
             pathname,
+            v4RemoveLegacyPostBuildHeadAttribute: params.v4RemoveLegacyPostBuildHeadAttribute,
         });
         // This renders the full page HTML, including head tags...
         const fullPageHtml = (0, ssgTemplate_1.renderSSGTemplate)({
             params,
-            result,
+            result: appRenderResult,
             ssgTemplate,
         });
         const minifierResult = await htmlMinifier.minify(fullPageHtml);
@@ -155,18 +94,26 @@ async function generateStaticFile({ pathname, renderer, params, htmlMinifier, ss
             params,
         });
         return {
-            collectedData: result.collectedData,
-            // As of today, only the html minifier can emit SSG warnings
-            warnings: minifierResult.warnings,
+            success: true,
+            pathname,
+            result: {
+                collectedData: appRenderResult.collectedData,
+                // As of today, only the html minifier can emit SSG warnings
+                warnings: minifierResult.warnings,
+            },
         };
     }
     catch (errorUnknown) {
         const error = errorUnknown;
         const tips = getSSGErrorTips(error);
         const message = logger_1.default.interpolate `Can't render static file for pathname path=${pathname}${tips ? `\n\n${tips}` : ''}`;
-        throw new Error(message, {
-            cause: error,
-        });
+        return {
+            success: false,
+            pathname,
+            error: new Error(message, {
+                cause: error,
+            }),
+        };
     }
 }
 function getSSGErrorTips(error) {

package/lib/ssg/ssgTemplate.js

@@ -35,15 +35,14 @@ function getScriptsAndStylesheets({ modules, manifest, }) {
 }
 function renderSSGTemplate({ params, result, ssgTemplate, }) {
     const { baseUrl, headTags, preBodyTags, postBodyTags, manifest, noIndex, DOCUSAURUS_VERSION, } = params;
-    const { html: appHtml, collectedData: { modules, helmet }, } = result;
+    const { html: appHtml, collectedData: { modules, metadata }, } = result;
     const { scripts, stylesheets } = getScriptsAndStylesheets({ manifest, modules });
-    const htmlAttributes = helmet.htmlAttributes.toString();
-    const bodyAttributes = helmet.bodyAttributes.toString();
+    const { htmlAttributes, bodyAttributes } = metadata.internal;
     const metaStrings = [
-        helmet.title.toString(),
-        helmet.meta.toString(),
-        helmet.link.toString(),
-        helmet.script.toString(),
+        metadata.internal.title,
+        metadata.internal.meta,
+        metadata.internal.link,
+        metadata.internal.script,
     ];
     const metaAttributes = metaStrings.filter(Boolean);
     const data = {

package/lib/ssg/ssgUtils.d.ts

@@ -5,7 +5,6 @@
  * LICENSE file in the root directory of this source tree.
  */
 import type { SSGParams } from './ssgParams';
-export declare const SSGConcurrency: number;
 export declare function generateHashRouterEntrypoint({ content, params, }: {
     content: string;
     params: SSGParams;

package/lib/ssg/ssgUtils.js

@@ -6,20 +6,11 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SSGConcurrency = void 0;
 exports.generateHashRouterEntrypoint = generateHashRouterEntrypoint;
 exports.writeStaticFile = writeStaticFile;
 const tslib_1 = require("tslib");
 const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
 const path_1 = tslib_1.__importDefault(require("path"));
-// Secret way to set SSR plugin concurrency option
-// Waiting for feedback before documenting this officially?
-exports.SSGConcurrency = process.env.DOCUSAURUS_SSR_CONCURRENCY
-    ? parseInt(process.env.DOCUSAURUS_SSR_CONCURRENCY, 10)
-    : // Not easy to define a reasonable option default
-        // Will still be better than Infinity
-        // See also https://github.com/sindresorhus/p-map/issues/24
-        32;
 function pathnameToFilename({ pathname, trailingSlash, }) {
     const outputFileName = pathname.replace(/^[/\\]/, ''); // Remove leading slashes for webpack-dev-server
     // Paths ending with .html are left untouched

package/lib/ssg/ssgWorkerInline.d.ts

@@ -0,0 +1,12 @@
+/**
+ * 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

@@ -0,0 +1,17 @@
+"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;
+}

package/lib/ssg/ssgWorkerThread.d.ts

@@ -0,0 +1,13 @@
+/**
+ * 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.js';
+export type SSGWorkerThreadTask = {
+    id: number;
+    pathnames: string[];
+};
+export default function executeSSGWorkerThreadTask(task: SSGWorkerThreadTask): Promise<SSGResult[]>;
+export type ExecuteSSGWorkerThreadTask = typeof executeSSGWorkerThreadTask;

package/lib/ssg/ssgWorkerThread.js

@@ -0,0 +1,36 @@
+"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.default = executeSSGWorkerThreadTask;
+const tslib_1 = require("tslib");
+const node_worker_threads_1 = require("node:worker_threads");
+const logger_1 = tslib_1.__importStar(require("@docusaurus/logger"));
+const ssgRenderer_js_1 = require("./ssgRenderer.js");
+// eslint-disable-next-line no-underscore-dangle
+const workerId = process?.__tinypool_state__?.workerId;
+if (!workerId) {
+    throw new Error('SSG Worker Thread not executing in Tinypool context?');
+}
+const params = node_worker_threads_1.workerData?.[1]?.params;
+if (!params) {
+    throw new Error(`SSG Worker Thread workerData params missing`);
+}
+const WorkerLogPrefix = `SSG Worker ${logger_1.default.name(workerId)}`;
+// 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)({
+    params,
+}));
+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": "3.7.0-canary-6200",
+  "version": "3.7.0-canary-6204",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -33,13 +33,13 @@
     "url": "https://github.com/facebook/docusaurus/issues"
   },
   "dependencies": {
-    "@docusaurus/babel": "3.7.0-canary-6200",
-    "@docusaurus/bundler": "3.7.0-canary-6200",
-    "@docusaurus/logger": "3.7.0-canary-6200",
-    "@docusaurus/mdx-loader": "3.7.0-canary-6200",
-    "@docusaurus/utils": "3.7.0-canary-6200",
-    "@docusaurus/utils-common": "3.7.0-canary-6200",
-    "@docusaurus/utils-validation": "3.7.0-canary-6200",
+    "@docusaurus/babel": "3.7.0-canary-6204",
+    "@docusaurus/bundler": "3.7.0-canary-6204",
+    "@docusaurus/logger": "3.7.0-canary-6204",
+    "@docusaurus/mdx-loader": "3.7.0-canary-6204",
+    "@docusaurus/utils": "3.7.0-canary-6204",
+    "@docusaurus/utils-common": "3.7.0-canary-6204",
+    "@docusaurus/utils-validation": "3.7.0-canary-6204",
     "boxen": "^6.2.1",
     "chalk": "^4.1.2",
     "chokidar": "^3.5.3",
@@ -69,6 +69,7 @@
     "semver": "^7.5.4",
     "serve-handler": "^6.1.6",
     "shelljs": "^0.8.5",
+    "tinypool": "^1.0.2",
     "tslib": "^2.6.0",
     "update-notifier": "^6.0.2",
     "webpack": "^5.95.0",
@@ -77,8 +78,8 @@
     "webpack-merge": "^6.0.1"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "3.7.0-canary-6200",
-    "@docusaurus/types": "3.7.0-canary-6200",
+    "@docusaurus/module-type-aliases": "3.7.0-canary-6204",
+    "@docusaurus/types": "3.7.0-canary-6204",
     "@total-typescript/shoehorn": "^0.1.2",
     "@types/detect-port": "^1.3.3",
     "@types/react-dom": "^18.2.7",
@@ -98,5 +99,5 @@
   "engines": {
     "node": ">=18.0"
   },
-  "gitHead": "0fcaaf4f7747ba0367cf5474089365fd0ec0455f"
+  "gitHead": "4b43b97230585b110910edb3d67dc844aedaf4ed"
 }

package/lib/ssg/ssg.d.ts

@@ -1,21 +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 { SSGParams } from './ssgParams';
-import type { AppRenderer, SiteCollectedData } from '../common';
-export declare function loadAppRenderer({ serverBundlePath, }: {
-    serverBundlePath: string;
-}): Promise<AppRenderer>;
-export declare function printSSGWarnings(results: {
-    pathname: string;
-    warnings: string[];
-}[]): void;
-export declare function generateStaticFiles({ pathnames, params, }: {
-    pathnames: string[];
-    params: SSGParams;
-}): Promise<{
-    collectedData: SiteCollectedData;
-}>;