@docusaurus/core 3.7.0-canary-6303 → 3.7.0-canary-6305

package/lib/client/serverEntry.js

@@ -12,7 +12,7 @@ import { renderToHtml } from './renderToHtml';
 import preload from './preload';
 import App from './App';
 import { createStatefulBrokenLinks, BrokenLinksProvider, } from './BrokenLinksContext';
-import { toPageCollectedMetadata } from './serverHelmetUtils';
+import { toPageCollectedMetadataInternal } from './serverHelmetUtils';
 const render = async ({ pathname, v4RemoveLegacyPostBuildHeadAttribute, }) => {
     await preload(pathname);
     const modules = new Set();
@@ -32,7 +32,7 @@ const render = async ({ pathname, v4RemoveLegacyPostBuildHeadAttribute, }) => {
     </Loadable.Capture>);
     const html = await renderToHtml(app);
     const { helmet } = helmetContext;
-    const metadata = toPageCollectedMetadata({ helmet });
+    const metadata = toPageCollectedMetadataInternal({ helmet });
     // TODO Docusaurus v4 remove with deprecated postBuild({head}) API
     //  the returned collectedData must be serializable to run in workers
     if (v4RemoveLegacyPostBuildHeadAttribute) {

package/lib/client/serverHelmetUtils.d.ts

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

package/lib/client/serverHelmetUtils.js

@@ -19,7 +19,7 @@ function isNoIndexTag(tag) {
         // Robots directives are not case-sensitive
         tag.content.toLowerCase().includes('noindex'));
 }
-export function toPageCollectedMetadata({ helmet, }) {
+export function toPageCollectedMetadataInternal({ helmet, }) {
     const tags = getBuildMetaTags(helmet);
     const noIndex = tags.some(isNoIndexTag);
     return {

package/lib/ssg/ssgExecutor.js

@@ -22,7 +22,7 @@ const ssgWorkerInline_1 = require("./ssgWorkerInline");
 const createSimpleSSGExecutor = async ({ params, pathnames, }) => {
     return {
         run: () => {
-            return logger_1.PerfLogger.async('Generate static files (current thread)', async () => {
+            return logger_1.PerfLogger.async('SSG (current thread)', async () => {
                 const ssgResults = await (0, ssgWorkerInline_1.executeSSGInlineTask)({
                     pathnames,
                     params,
@@ -73,7 +73,7 @@ const createPooledSSGExecutor = async ({ params, pathnames, }) => {
     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 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'));
         return new Tinypool({
@@ -88,10 +88,16 @@ const createPooledSSGExecutor = async ({ params, pathnames, }) => {
     });
     const pathnamesChunks = lodash_1.default.chunk(pathnames, ssgEnv_1.SSGWorkerThreadTaskSize);
     // Tiny wrapper for type-safety
-    const submitTask = (task) => pool.run(task);
+    const submitTask = async (task) => {
+        const result = await pool.run(task);
+        // Note, we don't use PerfLogger.async() because all tasks are submitted
+        // immediately at once and queued, while results are received progressively
+        logger_1.PerfLogger.log(`Result for task ${logger_1.default.name(task.id)}`);
+        return result;
+    };
     return {
         run: async () => {
-            const results = await logger_1.PerfLogger.async(`Generate static files (${numberOfThreads} worker threads)`, async () => {
+            const results = await logger_1.PerfLogger.async(`Thread pool`, async () => {
                 return Promise.all(pathnamesChunks.map((taskPathnames, taskIndex) => {
                     return submitTask({
                         id: taskIndex + 1,

package/lib/ssg/ssgRenderer.d.ts

@@ -5,12 +5,12 @@
  * LICENSE file in the root directory of this source tree.
  */
 import type { SSGParams } from './ssgParams';
-import type { AppRenderResult } from '../common';
+import type { PageCollectedData } from '../common';
 export type SSGSuccess = {
     success: true;
     pathname: string;
     result: {
-        collectedData: AppRenderResult['collectedData'];
+        collectedData: PageCollectedData;
         warnings: string[];
     };
 };

package/lib/ssg/ssgRenderer.js

@@ -74,6 +74,23 @@ async function loadSSGRenderer({ params, }) {
         },
     };
 }
+// We reduce the page collected data structure after the HTML file is written
+// Some data (modules, metadata.internal) is only useful to create the HTML file
+// It's not useful to aggregate that collected data in memory
+// Keep this data structure as small as possible
+// See https://github.com/facebook/docusaurus/pull/11162
+function reduceCollectedData(pageCollectedData) {
+    // We re-create the object from scratch
+    // We absolutely want to avoid TS duck typing
+    return {
+        anchors: pageCollectedData.anchors,
+        metadata: {
+            public: pageCollectedData.metadata.public,
+            helmet: pageCollectedData.metadata.helmet,
+        },
+        links: pageCollectedData.links,
+    };
+}
 async function generateStaticFile({ pathname, appRenderer, params, htmlMinifier, ssgTemplate, }) {
     try {
         // This only renders the app HTML
@@ -93,11 +110,12 @@ async function generateStaticFile({ pathname, appRenderer, params, htmlMinifier,
             content: minifierResult.code,
             params,
         });
+        const collectedData = reduceCollectedData(appRenderResult.collectedData);
         return {
             success: true,
             pathname,
             result: {
-                collectedData: appRenderResult.collectedData,
+                collectedData,
                 // As of today, only the html minifier can emit SSG warnings
                 warnings: minifierResult.warnings,
             },

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/core",
   "description": "Easy to Maintain Open Source Documentation Websites",
-  "version": "3.7.0-canary-6303",
+  "version": "3.7.0-canary-6305",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -33,13 +33,13 @@
     "url": "https://github.com/facebook/docusaurus/issues"
   },
   "dependencies": {
-    "@docusaurus/babel": "3.7.0-canary-6303",
-    "@docusaurus/bundler": "3.7.0-canary-6303",
-    "@docusaurus/logger": "3.7.0-canary-6303",
-    "@docusaurus/mdx-loader": "3.7.0-canary-6303",
-    "@docusaurus/utils": "3.7.0-canary-6303",
-    "@docusaurus/utils-common": "3.7.0-canary-6303",
-    "@docusaurus/utils-validation": "3.7.0-canary-6303",
+    "@docusaurus/babel": "3.7.0-canary-6305",
+    "@docusaurus/bundler": "3.7.0-canary-6305",
+    "@docusaurus/logger": "3.7.0-canary-6305",
+    "@docusaurus/mdx-loader": "3.7.0-canary-6305",
+    "@docusaurus/utils": "3.7.0-canary-6305",
+    "@docusaurus/utils-common": "3.7.0-canary-6305",
+    "@docusaurus/utils-validation": "3.7.0-canary-6305",
     "boxen": "^6.2.1",
     "chalk": "^4.1.2",
     "chokidar": "^3.5.3",
@@ -77,8 +77,8 @@
     "webpack-merge": "^6.0.1"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "3.7.0-canary-6303",
-    "@docusaurus/types": "3.7.0-canary-6303",
+    "@docusaurus/module-type-aliases": "3.7.0-canary-6305",
+    "@docusaurus/types": "3.7.0-canary-6305",
     "@total-typescript/shoehorn": "^0.1.2",
     "@types/detect-port": "^1.3.3",
     "@types/react-dom": "^18.2.7",
@@ -98,5 +98,5 @@
   "engines": {
     "node": ">=18.0"
   },
-  "gitHead": "3041e6f456152332274f1f681e40be16423d71d1"
+  "gitHead": "23671c5708319ffafb2b94e29eb850e4d6c4fa1b"
 }