Unverified Commit b0e1bf79 authored by Jamiboy Mohammad's avatar Jamiboy Mohammad Committed by GitHub

test: document deploy exclusions for suites that need a local server (#100483)

## Summary

Replaces 5 `TODO(deploy-test-completion)` markers with the concrete
reason the suite can't run against any deployment. The `@force-gate
!deploy` lines stay.

- **`custom-routes`** (main suite, "no-op rewrite", "solo types") and
**`i18n-support-base-path`**: `beforeAll` starts an HTTP server on a
port on the test runner and patches that port into `next.config.js`,
which a deployment can't reach. In the Sept 24 deploy run every test in
both suites failed on that setup.
- **`rewrites-hostname`**: rewrites to a server on a local port
(`你好.localhost:<port>`) and asserts localhost host headers. The
deployment returned its error page.

These need the test runner's own network, so they can't pass on any
deploy host. Other `TODO(deploy-test-completion)` suites that fail on
Vercel for fixable reasons keep their TODOs and will be enabled
separately.

## Verification

- Checked each reason against the failing assertions in the experiment
logs and the test code.
- Comment-only change.

<!-- NEXT_JS_LLM -->
parent 52b14004
...@@ -14,8 +14,8 @@ import { ...@@ -14,8 +14,8 @@ import {
} from 'next-test-utils' } from 'next-test-utils'
import { nextTestSetup, isNextDev } from 'e2e-utils' import { nextTestSetup, isNextDev } from 'e2e-utils'
// TODO(deploy-test-completion): Re-enable this suite in deploy mode. // Deploy mode exclusion: This suite starts an HTTP server on a local port and
// It likely asserts local CLI or runtime output that deploy tests do not expose. // patches that port into next.config.js, which a deployment can't reach.
// @force-gate !deploy // @force-gate !deploy
describe('Custom routes', () => { describe('Custom routes', () => {
const { next } = nextTestSetup({ const { next } = nextTestSetup({
...@@ -3474,8 +3474,8 @@ describe('Custom routes', () => { ...@@ -3474,8 +3474,8 @@ describe('Custom routes', () => {
}) })
} }
}) })
// TODO(deploy-test-completion): Re-enable this suite in deploy mode. // Deploy mode exclusion: This suite starts an HTTP server on a local port and
// It likely asserts local CLI or runtime output that deploy tests do not expose. // patches that port into next.config.js, which a deployment can't reach.
// @force-gate !deploy // @force-gate !deploy
describe('Custom routes no-op rewrite', () => { describe('Custom routes no-op rewrite', () => {
const { next, isTurbopack, isNextStart } = nextTestSetup({ const { next, isTurbopack, isNextStart } = nextTestSetup({
...@@ -3532,8 +3532,8 @@ describe('Custom routes no-op rewrite', () => { ...@@ -3532,8 +3532,8 @@ describe('Custom routes no-op rewrite', () => {
}) })
}) })
// TODO(deploy-test-completion): Re-enable this suite in deploy mode. // Deploy mode exclusion: This suite starts an HTTP server on a local port and
// It likely asserts local CLI or runtime output that deploy tests do not expose. // patches that port into next.config.js, which a deployment can't reach.
// @force-gate !deploy // @force-gate !deploy
describe('Custom routes solo types', () => { describe('Custom routes solo types', () => {
const { next } = nextTestSetup({ const { next } = nextTestSetup({
......
...@@ -7,8 +7,8 @@ import { nextTestSetup, isNextDev, type NextInstance } from 'e2e-utils' ...@@ -7,8 +7,8 @@ import { nextTestSetup, isNextDev, type NextInstance } from 'e2e-utils'
type BrowserOptions = Parameters<NextInstance['browser']>[1] type BrowserOptions = Parameters<NextInstance['browser']>[1]
// TODO(deploy-test-completion): Re-enable this suite in deploy mode. // Deploy mode exclusion: This suite starts an HTTP server on a local port and
// It likely mutates files in the isolated local fixture after setup. // patches that port into next.config.js, which a deployment can't reach.
// @force-gate !deploy // @force-gate !deploy
describe('i18n Support basePath', () => { describe('i18n Support basePath', () => {
const { next } = nextTestSetup({ const { next } = nextTestSetup({
......
...@@ -2,8 +2,8 @@ import { nextTestSetup } from 'e2e-utils' ...@@ -2,8 +2,8 @@ import { nextTestSetup } from 'e2e-utils'
import { findPort } from 'next-test-utils' import { findPort } from 'next-test-utils'
import createTargetServer from './target-server' import createTargetServer from './target-server'
// TODO(deploy-test-completion): Re-enable this suite in deploy mode. // Deploy mode exclusion: This suite rewrites to a server on a local port and
// It likely depends on a local server, proxy, process, or dynamically allocated port. // asserts localhost host headers, which a deployment can't reach.
// @force-gate !deploy // @force-gate !deploy
describe('rewrites hostname', () => { describe('rewrites hostname', () => {
const { next } = nextTestSetup({ const { next } = nextTestSetup({
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment