feat: implement removePluginHookSsrArgument future deprecation (#20433)

Author: sapphi-red

packages/vite/src/node/build.ts

@@ -75,6 +75,10 @@ import {
   BasicMinimalPluginContext,
   basePluginContextMeta,
 } from './server/pluginContainer'
+import {
+  isFutureDeprecationEnabled,
+  warnFutureDeprecation,
+} from './deprecations'
 import { prepareOutDirPlugin } from './plugins/prepareOutDir'
 import type { Environment } from './environment'
 
@@ -1086,13 +1090,21 @@ export function injectEnvironmentToHooks(
   for (const hook of Object.keys(clone) as RollupPluginHooks[]) {
     switch (hook) {
       case 'resolveId':
-        clone[hook] = wrapEnvironmentResolveId(environment, resolveId)
+        clone[hook] = wrapEnvironmentResolveId(
+          environment,
+          resolveId,
+          plugin.name,
+        )
         break
       case 'load':
-        clone[hook] = wrapEnvironmentLoad(environment, load)
+        clone[hook] = wrapEnvironmentLoad(environment, load, plugin.name)
         break
       case 'transform':
-        clone[hook] = wrapEnvironmentTransform(environment, transform)
+        clone[hook] = wrapEnvironmentTransform(
+          environment,
+          transform,
+          plugin.name,
+        )
         break
       default:
         if (ROLLUP_HOOKS.includes(hook)) {
@@ -1107,7 +1119,8 @@ export function injectEnvironmentToHooks(
 
 function wrapEnvironmentResolveId(
   environment: Environment,
-  hook?: Plugin['resolveId'],
+  hook: Plugin['resolveId'] | undefined,
+  pluginName: string,
 ): Plugin['resolveId'] {
   if (!hook) return
 
@@ -1117,7 +1130,7 @@ function wrapEnvironmentResolveId(
       injectEnvironmentInContext(this, environment),
       id,
       importer,
-      injectSsrFlag(options, environment),
+      injectSsrFlag(options, environment, pluginName),
     )
   }
 
@@ -1133,7 +1146,8 @@ function wrapEnvironmentResolveId(
 
 function wrapEnvironmentLoad(
   environment: Environment,
-  hook?: Plugin['load'],
+  hook: Plugin['load'] | undefined,
+  pluginName: string,
 ): Plugin['load'] {
   if (!hook) return
 
@@ -1142,7 +1156,7 @@ function wrapEnvironmentLoad(
     return fn.call(
       injectEnvironmentInContext(this, environment),
       id,
-      injectSsrFlag(args[0], environment),
+      injectSsrFlag(args[0], environment, pluginName),
     )
   }
 
@@ -1158,7 +1172,8 @@ function wrapEnvironmentLoad(
 
 function wrapEnvironmentTransform(
   environment: Environment,
-  hook?: Plugin['transform'],
+  hook: Plugin['transform'] | undefined,
+  pluginName: string,
 ): Plugin['transform'] {
   if (!hook) return
 
@@ -1168,7 +1183,7 @@ function wrapEnvironmentTransform(
       injectEnvironmentInContext(this, environment),
       code,
       importer,
-      injectSsrFlag(args[0], environment),
+      injectSsrFlag(args[0], environment, pluginName),
     )
   }
 
@@ -1218,13 +1233,37 @@ function injectEnvironmentInContext<Context extends MinimalPluginContext>(
 }
 
 function injectSsrFlag<T extends Record<string, any>>(
-  options?: T,
-  environment?: Environment,
+  options: T | undefined,
+  environment: Environment,
+  pluginName: string,
 ): T & { ssr?: boolean } {
-  const ssr = environment ? environment.config.consumer === 'server' : true
-  return { ...(options ?? {}), ssr } as T & {
+  let ssr = environment.config.consumer === 'server'
+  const newOptions = { ...(options ?? {}), ssr } as T & {
     ssr?: boolean
   }
+
+  if (
+    isFutureDeprecationEnabled(
+      environment?.getTopLevelConfig(),
+      'removePluginHookSsrArgument',
+    )
+  ) {
+    Object.defineProperty(newOptions, 'ssr', {
+      get() {
+        warnFutureDeprecation(
+          environment?.getTopLevelConfig(),
+          'removePluginHookSsrArgument',
+          `Used in plugin "${pluginName}".`,
+        )
+        return ssr
+      },
+      set(v) {
+        ssr = v
+      },
+    })
+  }
+
+  return newOptions
 }
 
 /*

packages/vite/src/node/deprecations.ts

@@ -41,6 +41,13 @@ const deprecationMessages = {
 
 let _ignoreDeprecationWarnings = false
 
+export function isFutureDeprecationEnabled(
+  config: ResolvedConfig,
+  type: keyof FutureOptions,
+): boolean {
+  return !!config.future?.[type]
+}
+
 // Later we could have a `warnDeprecation` utils when the deprecation is landed
 /**
  * Warn about future deprecations.

packages/vite/src/node/server/pluginContainer.ts

@@ -89,6 +89,10 @@ import { cleanUrl, unwrapId } from '../../shared/utils'
 import type { PluginHookUtils } from '../config'
 import type { Environment } from '../environment'
 import type { Logger } from '../logger'
+import {
+  isFutureDeprecationEnabled,
+  warnFutureDeprecation,
+} from '../deprecations'
 import type { DevEnvironment } from './environment'
 import { buildErrorMessage } from './middlewares/error'
 import type {
@@ -369,6 +373,7 @@ class EnvironmentPluginContainer<Env extends Environment = Environment> {
     const scan = !!options?.scan
     const ssr = this.environment.config.consumer === 'server'
     const ctx = new ResolveIdContext(this, skip, skipCalls, scan)
+    const topLevelConfig = this.environment.getTopLevelConfig()
 
     const mergedSkip = new Set<Plugin>(skip)
     for (const call of skipCalls ?? []) {
@@ -390,16 +395,39 @@ class EnvironmentPluginContainer<Env extends Environment = Environment> {
 
       ctx._plugin = plugin
 
+      const normalizedOptions = {
+        attributes: options?.attributes ?? {},
+        custom: options?.custom,
+        isEntry: !!options?.isEntry,
+        ssr,
+        scan,
+      }
+      if (
+        isFutureDeprecationEnabled(
+          topLevelConfig,
+          'removePluginHookSsrArgument',
+        )
+      ) {
+        let ssrTemp = ssr
+        Object.defineProperty(normalizedOptions, 'ssr', {
+          get() {
+            warnFutureDeprecation(
+              topLevelConfig,
+              'removePluginHookSsrArgument',
+              `Used in plugin "${plugin.name}".`,
+            )
+            return ssrTemp
+          },
+          set(v) {
+            ssrTemp = v
+          },
+        })
+      }
+
       const pluginResolveStart = debugPluginResolve ? performance.now() : 0
       const handler = getHookHandler(plugin.resolveId)
       const result = await this.handleHookPromise(
-        handler.call(ctx as any, rawId, importer, {
-          attributes: options?.attributes ?? {},
-          custom: options?.custom,
-          isEntry: !!options?.isEntry,
-          ssr,
-          scan,
-        }),
+        handler.call(ctx as any, rawId, importer, normalizedOptions),
       )
       if (!result) continue
 
@@ -442,7 +470,8 @@ class EnvironmentPluginContainer<Env extends Environment = Environment> {
   }
 
   async load(id: string): Promise<LoadResult | null> {
-    const ssr = this.environment.config.consumer === 'server'
+    let ssr = this.environment.config.consumer === 'server'
+    const topLevelConfig = this.environment.getTopLevelConfig()
     const options = { ssr }
     const ctx = new LoadPluginContext(this)
     for (const plugin of this.getSortedPlugins('load')) {
@@ -453,6 +482,28 @@ class EnvironmentPluginContainer<Env extends Environment = Environment> {
       if (filter && !filter(id)) continue
 
       ctx._plugin = plugin
+
+      if (
+        isFutureDeprecationEnabled(
+          topLevelConfig,
+          'removePluginHookSsrArgument',
+        )
+      ) {
+        Object.defineProperty(options, 'ssr', {
+          get() {
+            warnFutureDeprecation(
+              topLevelConfig,
+              'removePluginHookSsrArgument',
+              `Used in plugin "${plugin.name}".`,
+            )
+            return ssr
+          },
+          set(v) {
+            ssr = v
+          },
+        })
+      }
+
       const handler = getHookHandler(plugin.load)
       const result = await this.handleHookPromise(
         handler.call(ctx as any, id, options),
@@ -476,7 +527,8 @@ class EnvironmentPluginContainer<Env extends Environment = Environment> {
       inMap?: SourceDescription['map']
     },
   ): Promise<{ code: string; map: SourceMap | { mappings: '' } | null }> {
-    const ssr = this.environment.config.consumer === 'server'
+    let ssr = this.environment.config.consumer === 'server'
+    const topLevelConfig = this.environment.getTopLevelConfig()
     const optionsWithSSR = options ? { ...options, ssr } : { ssr }
     const inMap = options?.inMap
 
@@ -490,6 +542,27 @@ class EnvironmentPluginContainer<Env extends Environment = Environment> {
       const filter = getCachedFilterForPlugin(plugin, 'transform')
       if (filter && !filter(id, code)) continue
 
+      if (
+        isFutureDeprecationEnabled(
+          topLevelConfig,
+          'removePluginHookSsrArgument',
+        )
+      ) {
+        Object.defineProperty(optionsWithSSR, 'ssr', {
+          get() {
+            warnFutureDeprecation(
+              topLevelConfig,
+              'removePluginHookSsrArgument',
+              `Used in plugin "${plugin.name}".`,
+            )
+            return ssr
+          },
+          set(v) {
+            ssr = v
+          },
+        })
+      }
+
       ctx._updateActiveInfo(plugin, id, code)
       const start = debugPluginTransform ? performance.now() : 0
       let result: TransformResult | string | undefined