[backport] Add deprecation warning to Runtime config (#84168) (#84650)

devjiwonchoi · web-flow · commit ce3d9639d12e · 2025-10-08T23:21:34.000+02:00
This PR backports #84168
diff --git a/packages/next/config.js b/packages/next/config.js
@@ -1 +1,12 @@
-module.exports = require('./dist/shared/lib/runtime-config.external')
+let hasWarned = false
+
+module.exports = (() => {
+  if (!hasWarned) {
+    console.warn(
+      // ANSI code aligns with Next.js warning style from picocolors.
+      ' \x1b[33m\x1b[1m⚠\x1b[22m\x1b[39m Runtime config is deprecated and will be removed in Next.js 16. Please remove the usage of "next/config" from your project.'
+    )
+    hasWarned = true
+  }
+  return require('./dist/shared/lib/runtime-config.external')
+})()
diff --git a/packages/next/src/server/config-shared.ts b/packages/next/src/server/config-shared.ts
@@ -1235,14 +1235,16 @@ export interface NextConfig extends Record<string, any> {
   /**
    * Add public (in browser) runtime configuration to your app
    *
-   * @see [Runtime configuration](https://nextjs.org/docs/pages/api-reference/config/next-config-js/runtime-configuration
+   * @see [Runtime configuration](https://nextjs.org/docs/pages/api-reference/config/next-config-js/runtime-configuration)
+   * @deprecated Runtime config is deprecated and will be removed in Next.js 16.
    */
   publicRuntimeConfig?: { [key: string]: any }
 
   /**
    * Add server runtime configuration to your app
    *
-   * @see [Runtime configuration](https://nextjs.org/docs/pages/api-reference/config/next-config-js/runtime-configuration
+   * @see [Runtime configuration](https://nextjs.org/docs/pages/api-reference/config/next-config-js/runtime-configuration)
+   * @deprecated Runtime config is deprecated and will be removed in Next.js 16.
    */
   serverRuntimeConfig?: { [key: string]: any }
 
diff --git a/packages/next/src/server/config.ts b/packages/next/src/server/config.ts
@@ -109,6 +109,19 @@ function checkDeprecations(
     silent
   )
 
+  warnOptionHasBeenDeprecated(
+    userConfig,
+    'publicRuntimeConfig',
+    `Runtime config is deprecated and the \`publicRuntimeConfig\` configuration option will be removed in Next.js 16.`,
+    silent
+  )
+  warnOptionHasBeenDeprecated(
+    userConfig,
+    'serverRuntimeConfig',
+    `Runtime config is deprecated and the \`serverRuntimeConfig\` configuration option will be removed in Next.js 16.`,
+    silent
+  )
+
   if (userConfig.experimental?.dynamicIO !== undefined) {
     warnOptionHasBeenDeprecated(
       userConfig,
diff --git a/packages/next/src/shared/lib/runtime-config.external.ts b/packages/next/src/shared/lib/runtime-config.external.ts
@@ -1,9 +1,15 @@
 let runtimeConfig: any
 
+/**
+ * @deprecated Runtime config is deprecated and will be removed in Next.js 16.
+ */
 export default () => {
   return runtimeConfig
 }
 
+/**
+ * @deprecated Runtime config is deprecated and will be removed in Next.js 16.
+ */
 export function setConfig(configValue: any): void {
   runtimeConfig = configValue
 }
diff --git a/test/e2e/app-dir/deprecation-warning-runtime-config/app/layout.tsx b/test/e2e/app-dir/deprecation-warning-runtime-config/app/layout.tsx
@@ -0,0 +1,8 @@
+import { ReactNode } from 'react'
+export default function Root({ children }: { children: ReactNode }) {
+  return (
+    <html>
+      <body>{children}</body>
+    </html>
+  )
+}
diff --git a/test/e2e/app-dir/deprecation-warning-runtime-config/app/page.tsx b/test/e2e/app-dir/deprecation-warning-runtime-config/app/page.tsx
@@ -0,0 +1,6 @@
+import getConfig from 'next/config'
+
+export default function Page() {
+  getConfig()
+  return <p>hello world</p>
+}
diff --git a/test/e2e/app-dir/deprecation-warning-runtime-config/deprecation-warning-runtime-config.test.ts b/test/e2e/app-dir/deprecation-warning-runtime-config/deprecation-warning-runtime-config.test.ts
@@ -0,0 +1,16 @@
+import { nextTestSetup } from 'e2e-utils'
+
+describe('deprecation-warning-runtime-config', () => {
+  const { next } = nextTestSetup({
+    files: __dirname,
+  })
+
+  it('should warn when imported "next/config" module', async () => {
+    // Navigate to "/" for dev server to execute the code
+    await next.browser('/')
+
+    expect(next.cliOutput).toContain(
+      'Runtime config is deprecated and will be removed in Next.js 16. Please remove the usage of "next/config" from your project.'
+    )
+  })
+})
diff --git a/test/e2e/app-dir/deprecation-warning-runtime-config/next.config.js b/test/e2e/app-dir/deprecation-warning-runtime-config/next.config.js
@@ -0,0 +1,13 @@
+/**
+ * @type {import('next').NextConfig}
+ */
+const nextConfig = {
+  publicRuntimeConfig: {
+    foo: 'bar',
+  },
+  serverRuntimeConfig: {
+    foo: 'bar',
+  },
+}
+
+module.exports = nextConfig
diff --git a/test/e2e/deprecation-warnings/deprecation-warnings.test.ts b/test/e2e/deprecation-warnings/deprecation-warnings.test.ts
@@ -35,6 +35,14 @@ describe('deprecation-warnings', () => {
       // Should warn about experimental.instrumentationHook
       expect(logs).toContain('experimental.instrumentationHook')
       expect(logs).toContain('no longer needed')
+
+      // Should warn about publicRuntimeConfig
+      expect(logs).toContain('publicRuntimeConfig')
+      expect(logs).toContain('will be removed in Next.js 16')
+
+      // Should warn about serverRuntimeConfig
+      expect(logs).toContain('serverRuntimeConfig')
+      expect(logs).toContain('will be removed in Next.js 16')
     })
   })
 })
diff --git a/test/e2e/deprecation-warnings/fixtures/with-deprecated-config/next.config.js b/test/e2e/deprecation-warnings/fixtures/with-deprecated-config/next.config.js
@@ -1,3 +1,4 @@
+/** @type {import('next').NextConfig} */
 module.exports = {
   // Explicitly configure deprecated options
   amp: {
@@ -6,4 +7,10 @@ module.exports = {
   experimental: {
     instrumentationHook: true,
   },
+  publicRuntimeConfig: {
+    foo: 'bar',
+  },
+  serverRuntimeConfig: {
+    foo: 'bar',
+  },
 }

Original file line number	Diff line number	Diff line change
`@@ -1,9 +1,15 @@`
`1`	`1`	`let runtimeConfig: any`
`2`	`2`
	`3`	`+/**`
	`4`	`+ * @deprecated Runtime config is deprecated and will be removed in Next.js 16.`
	`5`	`+ */`
`3`	`6`	`export default () => {`
`4`	`7`	`return runtimeConfig`
`5`	`8`	`}`
`6`	`9`
	`10`	`+/**`
	`11`	`+ * @deprecated Runtime config is deprecated and will be removed in Next.js 16.`
	`12`	`+ */`
`7`	`13`	`export function setConfig(configValue: any): void {`
`8`	`14`	`runtimeConfig = configValue`
`9`	`15`	`}`