NNext.js 中文网 GitHub

exposeTestingApiInProductionBuild

experimental

在生产构建中暴露 Instant Navigation 测试 API,以支持端到端测试。

使用 experimental.exposeTestingApiInProductionBuild 将 Instant Navigation 测试 API 包含在生产构建中。@next/playwright 中的 instant() 辅助函数使用此 API 暂停请求时内容,以便端到端测试对立即可用的 UI 进行断言。

仅为专门的测试构建启用该选项:

next.config.ts
import type { NextConfig } from 'next'

const exposeTestingApi = process.env.EXPOSE_TESTING_API === '1'

const nextConfig: NextConfig = {
  cacheComponents: true,
  experimental: {
    exposeTestingApiInProductionBuild: exposeTestingApi,
  },
}

export default nextConfig
next.config.js
const exposeTestingApi = process.env.EXPOSE_TESTING_API === '1'

/** @type {import('next').NextConfig} */
const nextConfig = {
  cacheComponents: true,
  experimental: {
    exposeTestingApiInProductionBuild: exposeTestingApi,
  },
}

module.exports = nextConfig

在构建和启动测试服务器时设置 EXPOSE_TESTING_API=1:

Terminal
EXPOSE_TESTING_API=1 pnpm build
EXPOSE_TESTING_API=1 pnpm start

服务器会在启动时重新加载 next.config,因此在运行 next start 时要保持该选项启用。如果在启动时禁用该选项,instant() 将允许初始页面加载渲染请求时内容,同时仍然暂停客户端导航。

仅为 next start 设置该条件不会将测试 API 添加到已有构建中。

参考#

值行为
false 或未设置从生产构建中排除测试 API。这是默认值。
true在生产构建中包含测试 API。

该选项需要 cacheComponents。启用 Cache Components 后,开发构建会自动暴露测试 API。

小知识: 不要为面向用户的生产部署启用该选项。请将其限制在本地生产构建、预览部署或其他用于端到端测试的环境。

版本历史#

版本变更
v16.2.0引入 experimental.exposeTestingApiInProductionBuild。
Next.js 中文网