@docusaurus/core 0.0.0-5869 → 0.0.0-5872

package/lib/server/plugins/actions.d.ts

@@ -4,14 +4,14 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { LoadedPlugin, PluginContentLoadedActions, RouteConfig } from '@docusaurus/types';
+import type { InitializedPlugin, PluginContentLoadedActions, RouteConfig } from '@docusaurus/types';
 type PluginActionUtils = {
     getRoutes: () => RouteConfig[];
     getGlobalData: () => unknown;
     getActions: () => PluginContentLoadedActions;
 };
 export declare function createPluginActionsUtils({ plugin, generatedFilesDir, baseUrl, trailingSlash, }: {
-    plugin: LoadedPlugin;
+    plugin: InitializedPlugin;
     generatedFilesDir: string;
     baseUrl: string;
     trailingSlash: boolean | undefined;

package/lib/server/plugins/plugins.d.ts

@@ -10,15 +10,10 @@ export type LoadPluginsResult = {
     routes: RouteConfig[];
     globalData: GlobalData;
 };
-export declare function mergeGlobalData(...globalDataList: GlobalData[]): GlobalData;
 /**
  * Initializes the plugins and run their lifecycle functions.
  */
 export declare function loadPlugins(context: LoadContext): Promise<LoadPluginsResult>;
-export declare function getPluginByIdentifier({ plugins, pluginIdentifier, }: {
-    pluginIdentifier: PluginIdentifier;
-    plugins: LoadedPlugin[];
-}): LoadedPlugin;
 export declare function reloadPlugin({ pluginIdentifier, plugins: previousPlugins, context, }: {
     pluginIdentifier: PluginIdentifier;
     plugins: LoadedPlugin[];

package/lib/server/plugins/plugins.js

@@ -6,19 +6,16 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.reloadPlugin = exports.getPluginByIdentifier = exports.loadPlugins = exports.mergeGlobalData = void 0;
-const tslib_1 = require("tslib");
-const lodash_1 = tslib_1.__importDefault(require("lodash"));
-const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
+exports.reloadPlugin = exports.loadPlugins = void 0;
 const init_1 = require("./init");
 const synthetic_1 = require("./synthetic");
 const translations_1 = require("../translations/translations");
 const routeConfig_1 = require("./routeConfig");
 const utils_1 = require("../../utils");
 const actions_1 = require("./actions");
-async function translatePlugin({ plugin, context, }) {
-    const { content } = plugin;
-    const rawTranslationFiles = (await plugin.getTranslationFiles?.({ content: plugin.content })) ?? [];
+const pluginsUtils_1 = require("./pluginsUtils");
+async function translatePluginContent({ plugin, content, context, }) {
+    const rawTranslationFiles = (await plugin.getTranslationFiles?.({ content })) ?? [];
     const translationFiles = await Promise.all(rawTranslationFiles.map((translationFile) => (0, translations_1.localizePluginTranslationFile)({
         localizationDir: context.localizationDir,
         translationFile,
@@ -34,31 +31,23 @@ async function translatePlugin({ plugin, context, }) {
     // translate its own slice of theme config and should make no assumptions
     // about other plugins' keys, so this is safe to run in parallel.
     Object.assign(context.siteConfig.themeConfig, translatedThemeConfigSlice);
-    return { ...plugin, content: translatedContent };
+    return translatedContent;
 }
-async function executePluginLoadContent({ plugin, context, }) {
-    return utils_1.PerfLogger.async(`Plugin - loadContent - ${plugin.name}@${plugin.options.id}`, async () => {
-        const content = await plugin.loadContent?.();
-        const loadedPlugin = { ...plugin, content };
-        return translatePlugin({ plugin: loadedPlugin, context });
-    });
-}
-async function executePluginsLoadContent({ plugins, context, }) {
-    return utils_1.PerfLogger.async(`Plugins - loadContent`, () => Promise.all(plugins.map((plugin) => executePluginLoadContent({ plugin, context }))));
-}
-function aggregateAllContent(loadedPlugins) {
-    return lodash_1.default.chain(loadedPlugins)
-        .groupBy((item) => item.name)
-        .mapValues((nameItems) => lodash_1.default.chain(nameItems)
-        .groupBy((item) => item.options.id)
-        .mapValues((idItems) => idItems[0].content)
-        .value())
-        .value();
-}
-async function executePluginContentLoaded({ plugin, context, }) {
-    return utils_1.PerfLogger.async(`Plugins - contentLoaded - ${plugin.name}@${plugin.options.id}`, async () => {
+async function executePluginContentLoading({ plugin, context, }) {
+    return utils_1.PerfLogger.async(`Plugins - single plugin content loading - ${plugin.name}@${plugin.options.id}`, async () => {
+        let content = await plugin.loadContent?.();
+        content = await translatePluginContent({
+            plugin,
+            content,
+            context,
+        });
         if (!plugin.contentLoaded) {
-            return { routes: [], globalData: undefined };
+            return {
+                ...plugin,
+                content,
+                routes: [],
+                globalData: undefined,
+            };
         }
         const pluginActionsUtils = await (0, actions_1.createPluginActionsUtils)({
             plugin,
@@ -67,15 +56,22 @@ async function executePluginContentLoaded({ plugin, context, }) {
             trailingSlash: context.siteConfig.trailingSlash,
         });
         await plugin.contentLoaded({
-            content: plugin.content,
+            content,
             actions: pluginActionsUtils.getActions(),
         });
         return {
+            ...plugin,
+            content,
             routes: pluginActionsUtils.getRoutes(),
             globalData: pluginActionsUtils.getGlobalData(),
         };
     });
 }
+async function executeAllPluginsContentLoading({ plugins, context, }) {
+    return utils_1.PerfLogger.async(`Plugins - all plugins content loading`, () => {
+        return Promise.all(plugins.map((plugin) => executePluginContentLoading({ plugin, context })));
+    });
+}
 async function executePluginAllContentLoaded({ plugin, context, allContent, }) {
     return utils_1.PerfLogger.async(`Plugins - allContentLoaded - ${plugin.name}@${plugin.options.id}`, async () => {
         if (!plugin.allContentLoaded) {
@@ -97,31 +93,9 @@ async function executePluginAllContentLoaded({ plugin, context, allContent, }) {
         };
     });
 }
-async function executePluginsContentLoaded({ plugins, context, }) {
-    return utils_1.PerfLogger.async(`Plugins - contentLoaded`, async () => {
-        const routes = [];
-        const globalData = {};
-        await Promise.all(plugins.map(async (plugin) => {
-            var _a;
-            const { routes: pluginRoutes, globalData: pluginGlobalData } = await executePluginContentLoaded({
-                plugin,
-                context,
-            });
-            routes.push(...pluginRoutes);
-            if (pluginGlobalData !== undefined) {
-                globalData[_a = plugin.name] ?? (globalData[_a] = {});
-                globalData[plugin.name][plugin.options.id] = pluginGlobalData;
-            }
-        }));
-        // Sort the route config.
-        // This ensures that route with sub routes are always placed last.
-        (0, routeConfig_1.sortRoutes)(routes, context.siteConfig.baseUrl);
-        return { routes, globalData };
-    });
-}
-async function executePluginsAllContentLoaded({ plugins, context, }) {
+async function executeAllPluginsAllContentLoaded({ plugins, context, }) {
     return utils_1.PerfLogger.async(`Plugins - allContentLoaded`, async () => {
-        const allContent = aggregateAllContent(plugins);
+        const allContent = (0, pluginsUtils_1.aggregateAllContent)(plugins);
         const routes = [];
         const globalData = {};
         await Promise.all(plugins.map(async (plugin) => {
@@ -137,33 +111,16 @@ async function executePluginsAllContentLoaded({ plugins, context, }) {
                 globalData[plugin.name][plugin.options.id] = pluginGlobalData;
             }
         }));
-        // Sort the route config.
-        // This ensures that route with sub routes are always placed last.
-        (0, routeConfig_1.sortRoutes)(routes, context.siteConfig.baseUrl);
         return { routes, globalData };
     });
 }
-function mergeGlobalData(...globalDataList) {
-    const result = {};
-    const allPluginIdentifiers = globalDataList.flatMap((gd) => Object.keys(gd).flatMap((name) => Object.keys(gd[name]).map((id) => ({ name, id }))));
-    allPluginIdentifiers.forEach(({ name, id }) => {
-        const allData = globalDataList
-            .map((gd) => gd?.[name]?.[id])
-            .filter((d) => typeof d !== 'undefined');
-        const mergedData = allData.length === 1 ? allData[0] : Object.assign({}, ...allData);
-        result[name] ?? (result[name] = {});
-        result[name][id] = mergedData;
-    });
-    return result;
-}
-exports.mergeGlobalData = mergeGlobalData;
-function mergeResults({ contentLoadedResult, allContentLoadedResult, }) {
+function mergeResults({ plugins, allContentLoadedResult, }) {
     const routes = [
-        ...contentLoadedResult.routes,
+        ...(0, pluginsUtils_1.aggregateRoutes)(plugins),
         ...allContentLoadedResult.routes,
     ];
     (0, routeConfig_1.sortRoutes)(routes);
-    const globalData = mergeGlobalData(contentLoadedResult.globalData, allContentLoadedResult.globalData);
+    const globalData = (0, pluginsUtils_1.mergeGlobalData)((0, pluginsUtils_1.aggregateGlobalData)(plugins), allContentLoadedResult.globalData);
     return { routes, globalData };
 }
 /**
@@ -172,54 +129,49 @@ function mergeResults({ contentLoadedResult, allContentLoadedResult, }) {
 async function loadPlugins(context) {
     return utils_1.PerfLogger.async('Plugins - loadPlugins', async () => {
         const initializedPlugins = await utils_1.PerfLogger.async('Plugins - initPlugins', () => (0, init_1.initPlugins)(context));
+        // TODO probably not the ideal place to hardcode those plugins
         initializedPlugins.push((0, synthetic_1.createBootstrapPlugin)(context), (0, synthetic_1.createMDXFallbackPlugin)(context));
-        const plugins = await executePluginsLoadContent({
+        const plugins = await executeAllPluginsContentLoading({
             plugins: initializedPlugins,
             context,
         });
-        const contentLoadedResult = await executePluginsContentLoaded({
-            plugins,
-            context,
-        });
-        const allContentLoadedResult = await executePluginsAllContentLoaded({
+        const allContentLoadedResult = await executeAllPluginsAllContentLoaded({
             plugins,
             context,
         });
         const { routes, globalData } = mergeResults({
-            contentLoadedResult,
+            plugins,
             allContentLoadedResult,
         });
         return { plugins, routes, globalData };
     });
 }
 exports.loadPlugins = loadPlugins;
-function getPluginByIdentifier({ plugins, pluginIdentifier, }) {
-    const plugin = plugins.find((p) => p.name === pluginIdentifier.name && p.options.id === pluginIdentifier.id);
-    if (!plugin) {
-        throw new Error(logger_1.default.interpolate `Plugin not found for identifier ${pluginIdentifier.name}@${pluginIdentifier.id}`);
-    }
-    return plugin;
-}
-exports.getPluginByIdentifier = getPluginByIdentifier;
 async function reloadPlugin({ pluginIdentifier, plugins: previousPlugins, context, }) {
     return utils_1.PerfLogger.async('Plugins - reloadPlugin', async () => {
-        const plugin = getPluginByIdentifier({
+        const previousPlugin = (0, pluginsUtils_1.getPluginByIdentifier)({
             plugins: previousPlugins,
             pluginIdentifier,
         });
-        const reloadedPlugin = await executePluginLoadContent({ plugin, context });
-        const plugins = previousPlugins.with(previousPlugins.indexOf(plugin), reloadedPlugin);
-        // TODO optimize this, we shouldn't need to re-run this lifecycle
-        const contentLoadedResult = await executePluginsContentLoaded({
-            plugins,
+        const plugin = await executePluginContentLoading({
+            plugin: previousPlugin,
             context,
         });
-        const allContentLoadedResult = await executePluginsAllContentLoaded({
+        /*
+        // TODO Docusaurus v4 - upgrade to Node 20, use array.with()
+        const plugins = previousPlugins.with(
+          previousPlugins.indexOf(previousPlugin),
+          plugin,
+        );
+         */
+        const plugins = [...previousPlugins];
+        plugins[previousPlugins.indexOf(previousPlugin)] = plugin;
+        const allContentLoadedResult = await executeAllPluginsAllContentLoaded({
             plugins,
             context,
         });
         const { routes, globalData } = mergeResults({
-            contentLoadedResult,
+            plugins,
             allContentLoadedResult,
         });
         return { plugins, routes, globalData };

package/lib/server/plugins/pluginsUtils.d.ts

@@ -0,0 +1,15 @@
+/**
+ * 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 { AllContent, GlobalData, InitializedPlugin, LoadedPlugin, PluginIdentifier, RouteConfig } from '@docusaurus/types';
+export declare function getPluginByIdentifier<P extends InitializedPlugin>({ plugins, pluginIdentifier, }: {
+    pluginIdentifier: PluginIdentifier;
+    plugins: P[];
+}): P;
+export declare function aggregateAllContent(loadedPlugins: LoadedPlugin[]): AllContent;
+export declare function aggregateRoutes(loadedPlugins: LoadedPlugin[]): RouteConfig[];
+export declare function aggregateGlobalData(loadedPlugins: LoadedPlugin[]): GlobalData;
+export declare function mergeGlobalData(...globalDataList: GlobalData[]): GlobalData;

package/lib/server/plugins/pluginsUtils.js

@@ -0,0 +1,60 @@
+"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.mergeGlobalData = exports.aggregateGlobalData = exports.aggregateRoutes = exports.aggregateAllContent = exports.getPluginByIdentifier = void 0;
+const tslib_1 = require("tslib");
+const lodash_1 = tslib_1.__importDefault(require("lodash"));
+const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
+function getPluginByIdentifier({ plugins, pluginIdentifier, }) {
+    const plugin = plugins.find((p) => p.name === pluginIdentifier.name && p.options.id === pluginIdentifier.id);
+    if (!plugin) {
+        throw new Error(logger_1.default.interpolate `Plugin not found for identifier ${pluginIdentifier.name}@${pluginIdentifier.id}`);
+    }
+    return plugin;
+}
+exports.getPluginByIdentifier = getPluginByIdentifier;
+function aggregateAllContent(loadedPlugins) {
+    return lodash_1.default.chain(loadedPlugins)
+        .groupBy((item) => item.name)
+        .mapValues((nameItems) => lodash_1.default.chain(nameItems)
+        .groupBy((item) => item.options.id)
+        .mapValues((idItems) => idItems[0].content)
+        .value())
+        .value();
+}
+exports.aggregateAllContent = aggregateAllContent;
+function aggregateRoutes(loadedPlugins) {
+    return loadedPlugins.flatMap((p) => p.routes);
+}
+exports.aggregateRoutes = aggregateRoutes;
+function aggregateGlobalData(loadedPlugins) {
+    const globalData = {};
+    loadedPlugins.forEach((plugin) => {
+        var _a;
+        if (plugin.globalData !== undefined) {
+            globalData[_a = plugin.name] ?? (globalData[_a] = {});
+            globalData[plugin.name][plugin.options.id] = plugin.globalData;
+        }
+    });
+    return globalData;
+}
+exports.aggregateGlobalData = aggregateGlobalData;
+function mergeGlobalData(...globalDataList) {
+    const result = {};
+    const allPluginIdentifiers = globalDataList.flatMap((gd) => Object.keys(gd).flatMap((name) => Object.keys(gd[name]).map((id) => ({ name, id }))));
+    allPluginIdentifiers.forEach(({ name, id }) => {
+        const allData = globalDataList
+            .map((gd) => gd?.[name]?.[id])
+            .filter((d) => typeof d !== 'undefined');
+        const mergedData = allData.length === 1 ? allData[0] : Object.assign({}, ...allData);
+        result[name] ?? (result[name] = {});
+        result[name][id] = mergedData;
+    });
+    return result;
+}
+exports.mergeGlobalData = mergeGlobalData;

package/lib/server/plugins/synthetic.d.ts

@@ -4,17 +4,17 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { LoadedPlugin, LoadContext } from '@docusaurus/types';
+import type { LoadContext, InitializedPlugin } from '@docusaurus/types';
 /**
  * Make a synthetic plugin to:
  * - Inject site client modules
  * - Inject scripts/stylesheets
  */
-export declare function createBootstrapPlugin({ siteDir, siteConfig, }: LoadContext): LoadedPlugin;
+export declare function createBootstrapPlugin({ siteDir, siteConfig, }: LoadContext): InitializedPlugin;
 /**
  * Configure Webpack fallback mdx loader for md/mdx files out of content-plugin
  * folders. Adds a "fallback" mdx loader for mdx files that are not processed by
  * content plugins. This allows to do things such as importing repo/README.md as
  * a partial from another doc. Not ideal solution, but good enough for now
  */
-export declare function createMDXFallbackPlugin({ siteDir, siteConfig, }: LoadContext): LoadedPlugin;
+export declare function createMDXFallbackPlugin({ siteDir, siteConfig, }: LoadContext): InitializedPlugin;

package/lib/server/plugins/synthetic.js

@@ -18,7 +18,6 @@ function createBootstrapPlugin({ siteDir, siteConfig, }) {
     const { stylesheets, scripts, headTags, clientModules: siteConfigClientModules, } = siteConfig;
     return {
         name: 'docusaurus-bootstrap-plugin',
-        content: null,
         options: {
             id: 'default',
         },
@@ -61,7 +60,6 @@ exports.createBootstrapPlugin = createBootstrapPlugin;
 function createMDXFallbackPlugin({ siteDir, siteConfig, }) {
     return {
         name: 'docusaurus-mdx-fallback-plugin',
-        content: null,
         options: {
             id: 'default',
         },

package/lib/server/site.js

@@ -144,7 +144,6 @@ async function reloadSite(site) {
 }
 exports.reloadSite = reloadSite;
 async function reloadSitePlugin(site, pluginIdentifier) {
-    console.log(`reloadSitePlugin ${pluginIdentifier.name}@${pluginIdentifier.id}`);
     const { plugins, routes, globalData } = await (0, plugins_1.reloadPlugin)({
         pluginIdentifier,
         plugins: site.props.plugins,

package/lib/utils.js

@@ -12,6 +12,11 @@ const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 // For now this is a private env variable we use internally
 // But we'll want to expose this feature officially some day
 exports.PerfDebuggingEnabled = !!process.env.DOCUSAURUS_PERF_LOGGER;
+const Thresholds = {
+    min: 5,
+    yellow: 100,
+    red: 1000,
+};
 function createPerfLogger() {
     if (!exports.PerfDebuggingEnabled) {
         const noop = () => { };
@@ -23,13 +28,36 @@ function createPerfLogger() {
         };
     }
     const prefix = logger_1.default.yellow(`[PERF] `);
-    const start = (label) => console.time(prefix + label);
-    const end = (label) => console.timeEnd(prefix + label);
+    const formatDuration = (duration) => {
+        if (duration > Thresholds.red) {
+            return logger_1.default.red(`${(duration / 1000).toFixed(2)} seconds!`);
+        }
+        else if (duration > Thresholds.yellow) {
+            return logger_1.default.yellow(`${duration.toFixed(2)} ms`);
+        }
+        else {
+            return logger_1.default.green(`${duration.toFixed(2)} ms`);
+        }
+    };
+    const logDuration = (label, duration) => {
+        if (duration < Thresholds.min) {
+            return;
+        }
+        console.log(`${prefix + label} - ${formatDuration(duration)}`);
+    };
+    const start = (label) => performance.mark(label);
+    const end = (label) => {
+        const { duration } = performance.measure(label);
+        performance.clearMarks(label);
+        logDuration(label, duration);
+    };
     const log = (label) => console.log(prefix + label);
     const async = async (label, asyncFn) => {
         start(label);
+        const before = performance.now();
         const result = await asyncFn();
-        end(label);
+        const duration = performance.now() - before;
+        logDuration(label, duration);
         return result;
     };
     return {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/core",
   "description": "Easy to Maintain Open Source Documentation Websites",
-  "version": "0.0.0-5869",
+  "version": "0.0.0-5872",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -43,13 +43,13 @@
     "@babel/runtime": "^7.22.6",
     "@babel/runtime-corejs3": "^7.22.6",
     "@babel/traverse": "^7.22.8",
-    "@docusaurus/cssnano-preset": "0.0.0-5869",
-    "@docusaurus/logger": "0.0.0-5869",
-    "@docusaurus/mdx-loader": "0.0.0-5869",
+    "@docusaurus/cssnano-preset": "0.0.0-5872",
+    "@docusaurus/logger": "0.0.0-5872",
+    "@docusaurus/mdx-loader": "0.0.0-5872",
     "@docusaurus/react-loadable": "5.5.2",
-    "@docusaurus/utils": "0.0.0-5869",
-    "@docusaurus/utils-common": "0.0.0-5869",
-    "@docusaurus/utils-validation": "0.0.0-5869",
+    "@docusaurus/utils": "0.0.0-5872",
+    "@docusaurus/utils-common": "0.0.0-5872",
+    "@docusaurus/utils-validation": "0.0.0-5872",
     "@svgr/webpack": "^6.5.1",
     "autoprefixer": "^10.4.14",
     "babel-loader": "^9.1.3",
@@ -105,8 +105,8 @@
     "webpackbar": "^5.0.2"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "0.0.0-5869",
-    "@docusaurus/types": "0.0.0-5869",
+    "@docusaurus/module-type-aliases": "0.0.0-5872",
+    "@docusaurus/types": "0.0.0-5872",
     "@total-typescript/shoehorn": "^0.1.2",
     "@types/detect-port": "^1.3.3",
     "@types/react-dom": "^18.2.7",
@@ -126,5 +126,5 @@
   "engines": {
     "node": ">=18.0"
   },
-  "gitHead": "b04beb0c2db54db2bf9f87733009a35221383933"
+  "gitHead": "b059cfb578e4a80cdd8b5cf9a3c8978fb41693e3"
 }