feat: add modifyEnvironmentConfig hook (#2707)

web-infra-dev · Jun 26, 2024 · f2483ac · f2483ac
1 parent e1d7e38
commit f2483ac
Show file tree

Hide file tree

Showing 9 changed files with 552 additions and 19 deletions.
diff --git a/packages/core/src/initHooks.ts b/packages/core/src/initHooks.ts
@@ -2,6 +2,7 @@ import type {
   AsyncHook,
   HookDescriptor,
   ModifyBundlerChainFn,
+  ModifyEnvironmentConfigFn,
   ModifyHTMLTagsFn,
   ModifyRsbuildConfigFn,
   ModifyRspackConfigFn,
@@ -80,6 +81,7 @@ export function initHooks() {
     modifyWebpackChain: createAsyncHook<ModifyWebpackChainFn>(),
     modifyWebpackConfig: createAsyncHook<ModifyWebpackConfigFn>(),
     modifyRsbuildConfig: createAsyncHook<ModifyRsbuildConfigFn>(),
+    modifyEnvironmentConfig: createAsyncHook<ModifyEnvironmentConfigFn>(),
   };
 }
 

diff --git a/packages/core/src/initPlugins.ts b/packages/core/src/initPlugins.ts
@@ -184,5 +184,6 @@ export function getPluginAPI({
     modifyWebpackChain: hooks.modifyWebpackChain.tap,
     modifyWebpackConfig: hooks.modifyWebpackConfig.tap,
     modifyRsbuildConfig: hooks.modifyRsbuildConfig.tap,
+    modifyEnvironmentConfig: hooks.modifyEnvironmentConfig.tap,
   };
 }
diff --git a/packages/core/src/provider/initConfigs.ts b/packages/core/src/provider/initConfigs.ts
@@ -1,5 +1,7 @@
 import type {
   InspectConfigOptions,
+  MergedEnvironmentConfig,
+  ModifyEnvironmentConfigUtils,
   NormalizedEnvironmentConfig,
   PluginManager,
   RsbuildEntry,
@@ -33,16 +35,33 @@ async function modifyRsbuildConfig(context: InternalContext) {
   logger.debug('modify Rsbuild config done');
 }
 
+async function modifyEnvironmentConfig(
+  context: InternalContext,
+  config: MergedEnvironmentConfig,
+  name: string,
+) {
+  logger.debug(`modify Rsbuild environment(${name}) config`);
+  const [modified] = await context.hooks.modifyEnvironmentConfig.call(config, {
+    name,
+    mergeEnvironmentConfig:
+      mergeRsbuildConfig<MergedEnvironmentConfig> as ModifyEnvironmentConfigUtils['mergeEnvironmentConfig'],
+  });
+
+  logger.debug(`modify Rsbuild environment(${name}) config done`);
+
+  return modified;
+}
+
 export type InitConfigsOptions = {
   context: InternalContext;
   pluginManager: PluginManager;
   rsbuildOptions: Required<CreateRsbuildOptions>;
 };
 
-const normalizeEnvironmentsConfigs = (
+const initEnvironmentConfigs = (
   normalizedConfig: NormalizedConfig,
   rootPath: string,
-): Record<string, NormalizedEnvironmentConfig> => {
+): Record<string, MergedEnvironmentConfig> => {
   let defaultEntry: RsbuildEntry;
   const getDefaultEntryWithMemo = () => {
     if (!defaultEntry) {
@@ -52,20 +71,25 @@ const normalizeEnvironmentsConfigs = (
   };
   const { environments, dev, server, provider, ...rsbuildSharedConfig } =
     normalizedConfig;
+  const { assetPrefix, lazyCompilation } = dev;
+
   if (environments && Object.keys(environments).length) {
     return Object.fromEntries(
       Object.entries(environments).map(([name, config]) => {
-        const environmentConfig = {
-          ...mergeRsbuildConfig(
-            rsbuildSharedConfig,
-            config as unknown as NormalizedEnvironmentConfig,
-          ),
-          dev,
-          server,
+        const environmentConfig: MergedEnvironmentConfig = {
+          ...(mergeRsbuildConfig(
+            {
+              ...rsbuildSharedConfig,
+              dev: {
+                assetPrefix,
+                lazyCompilation,
+              },
+            } as unknown as MergedEnvironmentConfig,
+            config as unknown as MergedEnvironmentConfig,
+          ) as unknown as MergedEnvironmentConfig),
         };
 
         if (!environmentConfig.source.entry) {
-          // @ts-expect-error
           environmentConfig.source.entry = getDefaultEntryWithMemo();
         }
 
@@ -81,9 +105,11 @@ const normalizeEnvironmentsConfigs = (
         ...rsbuildSharedConfig.source,
         entry: rsbuildSharedConfig.source.entry ?? getDefaultEntryWithMemo(),
       },
-      dev,
-      server,
-    },
+      dev: {
+        assetPrefix,
+        lazyCompilation,
+      },
+    } as MergedEnvironmentConfig,
   };
 };
 
@@ -107,11 +133,35 @@ export async function initRsbuildConfig({
   await modifyRsbuildConfig(context);
   const normalizeBaseConfig = normalizeConfig(context.config);
 
-  const environments = normalizeEnvironmentsConfigs(
+  const environments: Record<string, NormalizedEnvironmentConfig> = {};
+
+  const mergedEnvironments = initEnvironmentConfigs(
     normalizeBaseConfig,
     context.rootPath,
   );
 
+  const {
+    dev: { assetPrefix, lazyCompilation, ...rsbuildSharedDev },
+    server,
+  } = normalizeBaseConfig;
+
+  for (const [name, config] of Object.entries(mergedEnvironments)) {
+    const environmentConfig = await modifyEnvironmentConfig(
+      context,
+      config,
+      name,
+    );
+
+    environments[name] = {
+      ...environmentConfig,
+      dev: {
+        ...environmentConfig.dev,
+        ...rsbuildSharedDev,
+      },
+      server,
+    };
+  }
+
   context.normalizedConfig = {
     ...normalizeBaseConfig,
     environments,