refactor(core): improve dev perf, fine-grained site reloads - part1 (#…

…9903)
facebook · Mar 8, 2024 · d02b96f · d02b96f
1 parent eb6424c
commit d02b96f
Show file tree

Hide file tree

Showing 45 changed files with 2,100 additions and 1,332 deletions.
diff --git a/packages/docusaurus-plugin-content-docs/src/__tests__/docs.test.ts b/packages/docusaurus-plugin-content-docs/src/__tests__/docs.test.ts
@@ -7,7 +7,7 @@
 
 import {jest} from '@jest/globals';
 import path from 'path';
-import {loadContext} from '@docusaurus/core/src/server/index';
+import {loadContext} from '@docusaurus/core/src/server/site';
 import {createSlugger, posixPath, DEFAULT_PLUGIN_ID} from '@docusaurus/utils';
 import {createSidebarsUtils} from '../sidebars/utils';
 import {

diff --git a/packages/docusaurus-plugin-content-docs/src/__tests__/index.test.ts b/packages/docusaurus-plugin-content-docs/src/__tests__/index.test.ts
@@ -12,9 +12,9 @@ import _ from 'lodash';
 import {isMatch} from 'picomatch';
 import commander from 'commander';
 import webpack from 'webpack';
-import {loadContext} from '@docusaurus/core/src/server/index';
+import {loadContext} from '@docusaurus/core/src/server/site';
 import {applyConfigureWebpack} from '@docusaurus/core/src/webpack/utils';
-import {sortConfig} from '@docusaurus/core/src/server/plugins/routeConfig';
+import {sortRoutes} from '@docusaurus/core/src/server/plugins/routeConfig';
 import {posixPath} from '@docusaurus/utils';
 import {normalizePluginOptions} from '@docusaurus/utils-validation';
 
@@ -109,7 +109,7 @@ Entries created:
     expectSnapshot: () => {
       // Sort the route config like in src/server/plugins/index.ts for
       // consistent snapshot ordering
-      sortConfig(routeConfigs);
+      sortRoutes(routeConfigs);
       expect(routeConfigs).not.toEqual([]);
       expect(routeConfigs).toMatchSnapshot('route config');
       expect(dataContainer).toMatchSnapshot('data');

diff --git a/packages/docusaurus-plugin-content-pages/src/__tests__/index.test.ts b/packages/docusaurus-plugin-content-pages/src/__tests__/index.test.ts
@@ -6,7 +6,7 @@
  */
 
 import path from 'path';
-import {loadContext} from '@docusaurus/core/lib/server';
+import {loadContext} from '@docusaurus/core/src/server/site';
 import {normalizePluginOptions} from '@docusaurus/utils-validation';
 
 import pluginContentPages from '../index';

diff --git a/packages/docusaurus-types/src/plugin.d.ts b/packages/docusaurus-types/src/plugin.d.ts
@@ -163,6 +163,15 @@ export type Plugin<Content = unknown> = {
   }) => ThemeConfig;
 };
 
+/**
+ * Data required to uniquely identify a plugin
+ * The name or instance id alone is not enough
+ */
+export type PluginIdentifier = {
+  readonly name: string;
+  readonly id: string;
+};
+
 export type InitializedPlugin = Plugin & {
   readonly options: Required<PluginOptions>;
   readonly version: PluginVersionInformation;

diff --git a/packages/docusaurus/src/commands/build.ts b/packages/docusaurus/src/commands/build.ts
@@ -10,7 +10,7 @@ import path from 'path';
 import _ from 'lodash';
 import logger from '@docusaurus/logger';
 import {DOCUSAURUS_VERSION, mapAsyncSequential} from '@docusaurus/utils';
-import {load, loadContext, type LoadContextOptions} from '../server';
+import {loadSite, loadContext, type LoadContextParams} from '../server/site';
 import {handleBrokenLinks} from '../server/brokenLinks';
 
 import {createBuildClientConfig} from '../webpack/client';
@@ -32,7 +32,7 @@ import type {LoadedPlugin, Props} from '@docusaurus/types';
 import type {SiteCollectedData} from '../common';
 
 export type BuildCLIOptions = Pick<
-  LoadContextOptions,
+  LoadContextParams,
   'config' | 'locale' | 'outDir'
 > & {
   bundleAnalyzer?: boolean;
@@ -161,7 +161,7 @@ async function buildLocale({
   logger.info`name=${`[${locale}]`} Creating an optimized production build...`;
 
   PerfLogger.start('Loading site');
-  const props: Props = await load({
+  const site = await loadSite({
     siteDir,
     outDir: cliOptions.outDir,
     config: cliOptions.config,
@@ -170,7 +170,7 @@ async function buildLocale({
   });
   PerfLogger.end('Loading site');
 
-  // Apply user webpack config.
+  const {props} = site;
   const {outDir, plugins} = props;
 
   // We can build the 2 configs in parallel

diff --git a/packages/docusaurus/src/commands/deploy.ts b/packages/docusaurus/src/commands/deploy.ts
@@ -11,11 +11,11 @@ import os from 'os';
 import logger from '@docusaurus/logger';
 import shell from 'shelljs';
 import {hasSSHProtocol, buildSshUrl, buildHttpsUrl} from '@docusaurus/utils';
-import {loadContext, type LoadContextOptions} from '../server';
+import {loadContext, type LoadContextParams} from '../server/site';
 import {build} from './build';
 
 export type DeployCLIOptions = Pick<
-  LoadContextOptions,
+  LoadContextParams,
   'config' | 'locale' | 'outDir'
 > & {
   skipBuild?: boolean;

diff --git a/packages/docusaurus/src/commands/external.ts b/packages/docusaurus/src/commands/external.ts
@@ -6,7 +6,7 @@
  */
 
 import fs from 'fs-extra';
-import {loadContext} from '../server';
+import {loadContext} from '../server/site';
 import {initPlugins} from '../server/plugins/init';
 import type {CommanderStatic} from 'commander';
 

diff --git a/packages/docusaurus/src/commands/serve.ts b/packages/docusaurus/src/commands/serve.ts
@@ -15,10 +15,10 @@ import openBrowser from 'react-dev-utils/openBrowser';
 import {loadSiteConfig} from '../server/config';
 import {build} from './build';
 import {getHostPort, type HostPortOptions} from '../server/getHostPort';
-import type {LoadContextOptions} from '../server';
+import type {LoadContextParams} from '../server/site';
 
 export type ServeCLIOptions = HostPortOptions &
-  Pick<LoadContextOptions, 'config'> & {
+  Pick<LoadContextParams, 'config'> & {
     dir?: string;
     build?: boolean;
     open?: boolean;