refactor: bounded plugins factory instead of create hook

patak-dev · patak-dev · commit 6b74221266ae · 2024-05-01T21:30:01.000+02:00
diff --git a/docs/guide/api-vite-environment.md b/docs/guide/api-vite-environment.md
@@ -581,22 +581,19 @@ The hook can choose to:
 
 ### Per-environment Plugins
 
-There is a new `create` hook that plugins can define to lazily create per-environment plugins.
+A plugin can now also be a constructor to lazily create per-environment plugins.
 
 ```js
 function perEnvironmentPlugin() {
-  return {
-    name: 'per-environment-plugin',
+  return (environment: Environment) => {
     // Return a plugin, an array, a Promise, or a falsy value for each environment
-    create(environment: Environment) {
-      if (!passesCondition(environment)) {
-        return undefined
-      }
-      return [
-        createEnvironmentPlugin(environment),
-        otherPlugin(environment)
-      ]
+    if (!passesCondition(environment)) {
+      return undefined
     }
+    return [
+      createEnvironmentPlugin(environment),
+      otherPlugin(environment)
+    ]
   }
 }
 ```
diff --git a/packages/vite/src/node/build.ts b/packages/vite/src/node/build.ts
@@ -66,7 +66,7 @@ import { mergeConfig } from './publicUtils'
 import { webWorkerPostPlugin } from './plugins/worker'
 import { getHookHandler } from './plugins'
 import { Environment } from './environment'
-import type { Plugin, PluginContext } from './plugin'
+import type { BoundedPluginConstructor, Plugin, PluginContext } from './plugin'
 
 export interface BuildEnvironmentOptions {
   /**
@@ -534,7 +534,7 @@ export async function build(
 function resolveConfigToBuild(
   inlineConfig: InlineConfig = {},
   patchConfig?: (config: ResolvedConfig) => void,
-  patchPlugins?: (plugins: Plugin[]) => void,
+  patchPlugins?: (rawPlugins: (Plugin | BoundedPluginConstructor)[]) => void,
 ) {
   return resolveConfig(
     inlineConfig,
@@ -1525,13 +1525,18 @@ export async function createBuilder(
           lib: false,
         }
       }
-      const patchPlugins = (resolvedPlugins: Plugin[]) => {
+      const patchPlugins = (
+        rawPlugins: (Plugin | BoundedPluginConstructor)[],
+      ) => {
         // Force opt-in shared plugins
-        const environmentPlugins = [...resolvedPlugins]
+        const environmentPlugins = [...rawPlugins]
         let validMixedPlugins = true
         for (let i = 0; i < environmentPlugins.length; i++) {
           const environmentPlugin = environmentPlugins[i]
-          const sharedPlugin = config.plugins[i]
+          if (typeof environmentPlugin === 'function') {
+            continue
+          }
+          const sharedPlugin = config.rawPlugins[i]
           if (
             config.builder.sharedPlugins ||
             environmentPlugin.sharedDuringBuild
@@ -1545,7 +1550,7 @@ export async function createBuilder(
         }
         if (validMixedPlugins) {
           for (let i = 0; i < environmentPlugins.length; i++) {
-            resolvedPlugins[i] = environmentPlugins[i]
+            rawPlugins[i] = environmentPlugins[i]
           }
         }
       }
diff --git a/packages/vite/src/node/config.ts b/packages/vite/src/node/config.ts
@@ -21,6 +21,7 @@ import {
   FS_PREFIX,
 } from './constants'
 import type {
+  BoundedPluginConstructor,
   HookHandler,
   Plugin,
   PluginEnvironment,
@@ -71,9 +72,9 @@ import {
 import { getFsUtils } from './fsUtils'
 import {
   createPluginHookUtils,
+  createResolvePlugins,
   getHookHandler,
   getSortedPluginsByHook,
-  resolvePlugins,
 } from './plugins'
 import type { ESBuildOptions } from './plugins/esbuild'
 import type { InternalResolveOptions, ResolveOptions } from './plugins/resolve'
@@ -538,6 +539,13 @@ export type ResolvedConfig = Readonly<
       alias: Alias[]
     }
     plugins: readonly Plugin[]
+    rawPlugins: readonly (Plugin | BoundedPluginConstructor)[]
+    /** @internal inject user plugins into the shared vite pipeline */
+    resolvePlugins: (
+      prePlugins: Plugin[],
+      normalPlugins: Plugin[],
+      postPlugins: Plugin[],
+    ) => Plugin[]
     css: ResolvedCSSOptions
     esbuild: ESBuildOptions | false
     server: ResolvedServerOptions
@@ -761,7 +769,9 @@ export async function resolveConfig(
   defaultNodeEnv = 'development',
   isPreview = false,
   patchConfig: ((config: ResolvedConfig) => void) | undefined = undefined,
-  patchPlugins: ((plugins: Plugin[]) => void) | undefined = undefined,
+  patchPlugins:
+    | ((plugins: (Plugin | BoundedPluginConstructor)[]) => void)
+    | undefined = undefined,
 ): Promise<ResolvedConfig> {
   let config = inlineConfig
   let configFileDependencies: string[] = []
@@ -802,10 +812,10 @@ export async function resolveConfig(
   mode = inlineConfig.mode || config.mode || mode
   configEnv.mode = mode
 
-  const filterPlugin = (p: Plugin) => {
+  const filterPlugin = (p: Plugin | BoundedPluginConstructor) => {
     if (!p) {
       return false
-    } else if (!p.apply) {
+    } else if (typeof p === 'function' || !p.apply) {
       return true
     } else if (typeof p.apply === 'function') {
       return p.apply({ ...config, mode }, configEnv)
@@ -815,12 +825,22 @@ export async function resolveConfig(
   }
 
   // resolve plugins
-  const rawUserPlugins = (
-    (await asyncFlatten(config.plugins || [])) as Plugin[]
+  const rawPlugins = (
+    (await asyncFlatten(config.plugins || [])) as (
+      | Plugin
+      | BoundedPluginConstructor
+    )[]
   ).filter(filterPlugin)
 
+  // Backward compatibility hook used in builder, opt-in to shared plugins during build
+  patchPlugins?.(rawPlugins)
+
+  const sharedPlugins = rawPlugins.filter(
+    (plugin) => typeof plugin !== 'function',
+  ) as Plugin[]
+
   const [prePlugins, normalPlugins, postPlugins] =
-    sortUserPlugins(rawUserPlugins)
+    sortUserPlugins(sharedPlugins)
 
   const isBuild = command === 'build'
 
@@ -1119,8 +1139,8 @@ export async function resolveConfig(
       mainConfig: resolved,
       bundleChain,
     }
-    const resolvedWorkerPlugins = await resolvePlugins(
-      workerResolved,
+    const resolveWorkerPlugins = await createResolvePlugins(workerResolved)
+    const resolvedWorkerPlugins = resolveWorkerPlugins(
       workerPrePlugins,
       workerNormalPlugins,
       workerPostPlugins,
@@ -1159,7 +1179,9 @@ export async function resolveConfig(
     mainConfig: null,
     bundleChain: [],
     isProduction,
-    plugins: userPlugins,
+    plugins: userPlugins, // placeholder to be replaced
+    rawPlugins,
+    resolvePlugins: null as any, // placeholder to be replaced
     css: resolveCSSOptions(config.css),
     esbuild:
       config.esbuild === false
@@ -1296,15 +1318,12 @@ export async function resolveConfig(
   // gets called
   patchConfig?.(resolved)
 
-  const resolvedPlugins = await resolvePlugins(
-    resolved,
-    prePlugins,
-    normalPlugins,
-    postPlugins,
-  )
+  const resolvePlugins = await createResolvePlugins(resolved)
+
+  ;(resolved.resolvePlugins as any) = resolvePlugins
+
+  const resolvedPlugins = resolvePlugins(prePlugins, normalPlugins, postPlugins)
 
-  // Backward compatibility hook used in builder
-  patchPlugins?.(resolvedPlugins)
   ;(resolved.plugins as Plugin[]) = resolvedPlugins
 
   Object.assign(resolved, createPluginHookUtils(resolved.plugins))
diff --git a/packages/vite/src/node/index.ts b/packages/vite/src/node/index.ts
@@ -94,7 +94,12 @@ export type {
   SSROptions,
   SSRTarget,
 } from './ssr'
-export type { Plugin, HookHandler } from './plugin'
+export type {
+  BoundedPlugin,
+  BoundedPluginConstructor,
+  Plugin,
+  HookHandler,
+} from './plugin'
 export type {
   Logger,
   LogOptions,
diff --git a/packages/vite/src/node/plugin.ts b/packages/vite/src/node/plugin.ts
@@ -14,6 +14,7 @@ import type {
   ResolvedConfig,
   UserConfig,
 } from './config'
+import { sortUserPlugins } from './config'
 import type { ServerHook, ViteDevServer } from './server'
 import type { IndexHtmlTransform } from './plugins/html'
 import type { EnvironmentModuleNode } from './server/moduleGraph'
@@ -104,6 +105,20 @@ type ModifyHookContext<Hook, NewContext> = Hook extends {
   : ModifyFunctionContext<Hook, NewContext>
 
 export interface BasePlugin<A = any> extends RollupPlugin<A> {
+  /**
+   * Enforce plugin invocation tier similar to webpack loaders. Hooks ordering
+   * is still subject to the `order` property in the hook object.
+   *
+   * Plugin invocation order:
+   * - alias resolution
+   * - `enforce: 'pre'` plugins
+   * - vite core plugins
+   * - normal plugins
+   * - vite build plugins
+   * - `enforce: 'post'` plugins
+   * - vite build post plugins
+   */
+  enforce?: 'pre' | 'post'
   /**
    * Perform custom handling of HMR updates.
    * The handler receives a context containing changed filename, timestamp, a
@@ -203,27 +218,6 @@ export interface Plugin<A = any> extends BasePlugin<A> {
    * @experimental
    */
   sharedDuringBuild?: boolean
-  /**
-   * Spawn the plugin into multiple plugins based on the environment.
-   * This hook is called when the config has already been resolved, allowing to
-   * create per environment plugin pipelines or easily inject plugins for a
-   * only specific environments.
-   */
-  create?: (environment: PluginEnvironment) => BoundedPluginOption
-  /**
-   * Enforce plugin invocation tier similar to webpack loaders. Hooks ordering
-   * is still subject to the `order` property in the hook object.
-   *
-   * Plugin invocation order:
-   * - alias resolution
-   * - `enforce: 'pre'` plugins
-   * - vite core plugins
-   * - normal plugins
-   * - vite build plugins
-   * - `enforce: 'post'` plugins
-   * - vite build post plugins
-   */
-  enforce?: 'pre' | 'post'
   /**
    * Apply the plugin only for serve or build, or on certain conditions.
    */
@@ -345,7 +339,12 @@ export type BoundedPluginOption =
   | BoundedPluginOption[]
   | Promise<MaybeBoundedPlugin | BoundedPluginOption[]>
 
-export type MaybePlugin = Plugin | false | null | undefined
+export type MaybePlugin =
+  | Plugin
+  | BoundedPluginConstructor
+  | false
+  | null
+  | undefined
 
 export type PluginOption =
   | MaybePlugin
@@ -355,21 +354,22 @@ export type PluginOption =
 export async function resolveBoundedPlugins(
   environment: PluginEnvironment,
 ): Promise<BoundedPlugin[]> {
-  const resolvedPlugins: BoundedPlugin[] = []
-  for (const plugin of environment.config.plugins) {
-    resolvedPlugins.push(plugin)
-    if (plugin.create) {
-      const boundedPlugin = await plugin.create(environment)
+  const userPlugins: BoundedPlugin[] = []
+  for (const plugin of environment.config.rawPlugins) {
+    if (typeof plugin === 'function') {
+      const boundedPlugin = await plugin(environment)
       if (boundedPlugin) {
         const flatPlugins = await asyncFlattenBoundedPlugin(
           environment,
           boundedPlugin,
         )
-        resolvedPlugins.push(...flatPlugins)
+        userPlugins.push(...flatPlugins)
       }
+    } else {
+      userPlugins.push(plugin)
     }
   }
-  return resolvedPlugins
+  return environment.config.resolvePlugins(...sortUserPlugins(userPlugins))
 }
 
 async function asyncFlattenBoundedPlugin(
@@ -382,7 +382,7 @@ async function asyncFlattenBoundedPlugin(
   do {
     plugins = (
       await Promise.all(
-        plugins.map((p: any) => (p && p.split ? p.split(environment) : p)),
+        plugins.map((p: any) => (typeof p === 'function' ? p(environment) : p)),
       )
     )
       .flat(Infinity)
diff --git a/packages/vite/src/node/plugins/index.ts b/packages/vite/src/node/plugins/index.ts
