Unverified Commit 8d3e42e5 authored by Justin Ridgewell's avatar Justin Ridgewell Committed by GitHub

turbopack: bind server to IPv6 loopback (#47948)

This accomplishes 2 things:
1. binds the turbopack dev server to the IPv6 unspecified address
2. initializes our router with the same hostname/port of the turobpack
server

The first matches the behavior of the Node.js dev server. The IPv6
unspecified address is similar to IPv4's `0.0.0.0` address, allowing us
to accept connection from anywhere. Importantly, it _also_ allows
accepting IPv4 connections, making this address truly universal.

The second means the `request` parameter to any middleware will have the
correct origin, and the request's URL can be used to craft fetch
requests to API endpoints. `new URL(req.url).origin` will be the origin
of the turbopack dev server.

Fixes https://github.com/vercel/turbo/issues/4456
Fixes WEB-855
parent 40687dae
......@@ -10,7 +10,7 @@
"check": "tsc --noEmit"
},
"dependencies": {
"@vercel/turbopack-dev-runtime": "https://gitpkg.vercel.app/vercel/turbo/crates/turbopack-dev/js?turbopack-230321.3",
"@vercel/turbopack-dev-runtime": "https://gitpkg.vercel.app/vercel/turbo/crates/turbopack-dev/js?turbopack-230406.2",
"anser": "^2.1.1",
"css.escape": "^1.5.1",
"next": "*",
......
......@@ -3,7 +3,7 @@ import type { IncomingMessage, ServerResponse } from "node:http";
import { Buffer } from "node:buffer";
import { createServer, makeRequest } from "@vercel/turbopack-next/ipc/server";
import { toPairs } from "@vercel/turbopack-next/internal/headers";
import { makeResolver, RouteResult } from "next/dist/server/lib/route-resolver";
import { makeResolver, RouteResult, ServerAddress } from "next/dist/server/lib/route-resolver";
import loadConfig from "next/dist/server/config";
import { PHASE_DEVELOPMENT_SERVER } from "next/dist/shared/lib/constants";
......@@ -52,7 +52,8 @@ let resolveRouteMemo: Promise<
>;
async function getResolveRoute(
dir: string
dir: string,
serverAddr: Partial<ServerAddress>
): ReturnType<
typeof import("next/dist/server/lib/route-resolver").makeResolver
> {
......@@ -63,20 +64,22 @@ async function getResolveRoute(
undefined,
true
);
return await makeResolver(dir, nextConfig, {
const middlewareCfg = {
files: middlewareChunkGroup.filter((f) => /\.[mc]?js$/.test(f)),
matcher: middlewareConfig.matcher,
});
}
return await makeResolver(dir, nextConfig, middlewareCfg, serverAddr);
}
export default async function route(
ipc: Ipc<RouterRequest, IpcOutgoingMessage>,
routerRequest: RouterRequest,
dir: string
dir: string,
serverAddr: Partial<ServerAddress>
) {
const [resolveRoute, server] = await Promise.all([
(resolveRouteMemo ??= getResolveRoute(dir)),
(resolveRouteMemo ??= getResolveRoute(dir, serverAddr)),
createServer(),
]);
......
......@@ -385,6 +385,7 @@ async fn route_internal(
let Some(dir) = to_sys_path(project_path).await? else {
bail!("Next.js requires a disk path to check for valid routes");
};
let server_addr = server_addr.await?;
let result = evaluate(
router_asset,
project_path,
......@@ -396,6 +397,10 @@ async fn route_internal(
vec![
JsonValueVc::cell(request),
JsonValueVc::cell(dir.to_string_lossy().into()),
JsonValueVc::cell(json!({
"hostname": server_addr.hostname(),
"port": server_addr.port(),
})),
],
CompletionsVc::all(vec![next_config_changed, routes_changed]),
/* debug */ false,
......
......@@ -174,8 +174,6 @@ fn test_skipped_fails(resource: PathBuf) {
async fn run_test(resource: PathBuf) -> JestRunResult {
register();
let is_debug_start = *DEBUG_START;
let resource = canonicalize(resource).unwrap();
assert!(resource.exists(), "{} does not exist", resource.display());
assert!(
......@@ -196,11 +194,7 @@ async fn run_test(resource: PathBuf) -> JestRunResult {
let test_dir = resource.to_path_buf();
let workspace_root = cargo_workspace_root.parent().unwrap().parent().unwrap();
let project_dir = test_dir.join("input");
let requested_addr = if is_debug_start {
"127.0.0.1:3000".parse().unwrap()
} else {
get_free_local_addr().unwrap()
};
let requested_addr = get_free_local_addr().unwrap();
let mock_dir = resource.join("__httpmock__");
let mock_server_future = get_mock_server_future(&mock_dir);
......@@ -476,8 +470,8 @@ async fn run_browser(addr: SocketAddr) -> Result<JestRunResult> {
}
fn get_free_local_addr() -> Result<SocketAddr, std::io::Error> {
let socket = TcpSocket::new_v4()?;
socket.bind("127.0.0.1:0".parse().unwrap())?;
let socket = TcpSocket::new_v6()?;
socket.bind("[::]:0".parse().unwrap())?;
socket.local_addr()
}
......
import { NextResponse } from 'next/server'
import type { NextRequest } from 'next/server'
export async function middleware(req: NextRequest) {
const url = new URL(req.url)
const { searchParams } = url
const origin = searchParams.get('origin')
? `http://${searchParams.get('origin')}`
: url.origin
const res = await fetch(`${origin}/api/endpoint`)
const json = await res.json()
return NextResponse.json({ ...json, origin })
}
export const config = {
matcher: '/fetch-endpoint',
}
export default function handler(_req, res) {
res.status(200).json({ name: 'John Doe' })
}
import { useEffect } from 'react'
export default function Foo() {
useEffect(() => {
// Only run on client
import('@turbo/pack-test-harness').then(runTests)
})
return 'index'
}
function runTests() {
it('router has correct host when not specified', async () => {
// Without a host query param, the router will use the request's origin
// to fetch from the API endpoint.
const res = await fetch('/fetch-endpoint')
const env = await res.json()
expect(env).toHaveProperty('name', 'John Doe')
})
it('router can fetch localhost', async () => {
const res = await fetch(`/fetch-endpoint?host=localhost:${location.port}`)
const env = await res.json()
expect(env).toHaveProperty('name', 'John Doe')
})
it('router can fetch 127.0.0.1', async () => {
const res = await fetch(`/fetch-endpoint?host=127.0.0.1:${location.port}`)
const env = await res.json()
expect(env).toHaveProperty('name', 'John Doe')
})
it('router can fetch 0.0.0.0', async () => {
const res = await fetch(`/fetch-endpoint?host=0.0.0.0:${location.port}`)
const env = await res.json()
expect(env).toHaveProperty('name', 'John Doe')
})
it('router can fetch IPv6', async () => {
const res = await fetch(`/fetch-endpoint?host=[::1]:${location.port}`)
const env = await res.json()
expect(env).toHaveProperty('name', 'John Doe')
})
}
......@@ -37,7 +37,7 @@ pub struct DevServerOptions {
/// Hostname on which to start the application
#[cfg_attr(
feature = "cli",
clap(short = 'H', long, value_parser, default_value = "0.0.0.0")
clap(short = 'H', long, value_parser, default_value = "::")
)]
#[cfg_attr(feature = "serializable", serde(default = "default_host"))]
pub hostname: IpAddr,
......@@ -114,5 +114,7 @@ fn default_port() -> u16 {
#[cfg(feature = "serializable")]
fn default_host() -> IpAddr {
IpAddr::V4(std::net::Ipv4Addr::new(0, 0, 0, 0))
// IPv6 address can accept both IPv4 and v6 requests.
// https://nodejs.org/api/net.html#serverlistenport-host-backlog-callback
IpAddr::V6(std::net::Ipv6Addr::UNSPECIFIED)
}
......@@ -20,11 +20,16 @@ import {
} from '../../shared/lib/constants'
import type { BaseNextRequest } from '../base-http'
type MiddlewareConfig = {
export type MiddlewareConfig = {
matcher: string[]
files: string[]
}
export type ServerAddress = {
hostname: string
port: number
}
export type RouteResult =
| {
type: 'rewrite'
......@@ -78,7 +83,8 @@ class DevRouteMatcherManager extends DefaultRouteMatcherManager {
export async function makeResolver(
dir: string,
nextConfig: NextConfig,
middleware: MiddlewareConfig
middleware: MiddlewareConfig,
serverAddr: Partial<ServerAddress>
) {
const url = require('url') as typeof import('url')
const { default: Router } = require('../router') as typeof import('../router')
......@@ -126,8 +132,8 @@ export async function makeResolver(
const devServer = new TurbopackDevServerProxy({
dir,
conf: nextConfig,
hostname: 'localhost',
port: 3000,
hostname: serverAddr.hostname || 'localhost',
port: serverAddr.port || 3000,
})
await devServer.matchers.reload()
......
......@@ -1004,7 +1004,7 @@ importers:
'@types/react': ^18.0.26
'@types/react-dom': ^18.0.9
'@vercel/ncc': ^0.36.0
'@vercel/turbopack-dev-runtime': https://gitpkg.vercel.app/vercel/turbo/crates/turbopack-dev/js?turbopack-230321.3
'@vercel/turbopack-dev-runtime': https://gitpkg.vercel.app/vercel/turbo/crates/turbopack-dev/js?turbopack-230406.2
anser: ^2.1.1
css.escape: ^1.5.1
find-up: ^6.3.0
......@@ -1016,7 +1016,7 @@ importers:
stacktrace-parser: ^0.1.10
strip-ansi: ^7.0.1
dependencies:
'@vercel/turbopack-dev-runtime': '@gitpkg.vercel.app/vercel/turbo/crates/turbopack-dev/js?turbopack-230321.3_react-refresh@0.12.0'
'@vercel/turbopack-dev-runtime': '@gitpkg.vercel.app/vercel/turbo/crates/turbopack-dev/js?turbopack-230406.2_react-refresh@0.12.0'
anser: 2.1.1
css.escape: 1.5.1
next: link:../../../../next
......@@ -5973,7 +5973,7 @@ packages:
dependencies:
'@mdx-js/mdx': 2.2.1
source-map: 0.7.3
webpack: 5.74.0
webpack: 5.74.0_@swc+core@1.2.203
transitivePeerDependencies:
- supports-color
......@@ -6639,7 +6639,6 @@ packages:
cpu: [arm]
os: [android]
requiresBuild: true
dev: true
optional: true
/@swc/core-android-arm64/1.2.203:
......@@ -6648,7 +6647,6 @@ packages:
cpu: [arm64]
os: [android]
requiresBuild: true
dev: true
optional: true
/@swc/core-darwin-arm64/1.2.203:
......@@ -6657,7 +6655,6 @@ packages:
cpu: [arm64]
os: [darwin]
requiresBuild: true
dev: true
optional: true
/@swc/core-darwin-x64/1.2.203:
......@@ -6666,7 +6663,6 @@ packages:
cpu: [x64]
os: [darwin]
requiresBuild: true
dev: true
optional: true
/@swc/core-freebsd-x64/1.2.203:
......@@ -6675,7 +6671,6 @@ packages:
cpu: [x64]
os: [freebsd]
requiresBuild: true
dev: true
optional: true
/@swc/core-linux-arm-gnueabihf/1.2.203:
......@@ -6684,7 +6679,6 @@ packages:
cpu: [arm]
os: [linux]
requiresBuild: true
dev: true
optional: true
/@swc/core-linux-arm64-gnu/1.2.203:
......@@ -6693,7 +6687,6 @@ packages:
cpu: [arm64]
os: [linux]
requiresBuild: true
dev: true
optional: true
/@swc/core-linux-arm64-musl/1.2.203:
......@@ -6702,7 +6695,6 @@ packages:
cpu: [arm64]
os: [linux]
requiresBuild: true
dev: true
optional: true
/@swc/core-linux-x64-gnu/1.2.203:
......@@ -6711,7 +6703,6 @@ packages:
cpu: [x64]
os: [linux]
requiresBuild: true
dev: true
optional: true
/@swc/core-linux-x64-musl/1.2.203:
......@@ -6720,7 +6711,6 @@ packages:
cpu: [x64]
os: [linux]
requiresBuild: true
dev: true
optional: true
/@swc/core-win32-arm64-msvc/1.2.203:
......@@ -6729,7 +6719,6 @@ packages:
cpu: [arm64]
os: [win32]
requiresBuild: true
dev: true
optional: true
/@swc/core-win32-ia32-msvc/1.2.203:
......@@ -6738,7 +6727,6 @@ packages:
cpu: [ia32]
os: [win32]
requiresBuild: true
dev: true
optional: true
/@swc/core-win32-x64-msvc/1.2.203:
......@@ -6747,7 +6735,6 @@ packages:
cpu: [x64]
os: [win32]
requiresBuild: true
dev: true
optional: true
/@swc/core/1.2.203:
......@@ -6768,7 +6755,6 @@ packages:
'@swc/core-win32-arm64-msvc': 1.2.203
'@swc/core-win32-ia32-msvc': 1.2.203
'@swc/core-win32-x64-msvc': 1.2.203
dev: true
/@swc/helpers/0.4.11:
resolution: {integrity: sha512-rEUrBSGIoSFuYxwBYtlUFMlE2CwGhmW+w9355/5oduSw8e5h2+Tj4UrAGNNgP9915++wj5vkQo0UuOBqOAq4nw==}
......@@ -23741,7 +23727,6 @@ packages:
source-map: 0.6.1
terser: 5.14.1
webpack: 5.74.0_@swc+core@1.2.203
dev: true
/terser-webpack-plugin/5.2.4_webpack@5.74.0:
resolution: {integrity: sha512-E2CkNMN+1cho04YpdANyRrn8CyN4yMy+WdFKZIySFZrGXZxJwJP6PMNGGc/Mcr6qygQHUUqRxnAPmi0M9f00XA==}
......@@ -25147,7 +25132,6 @@ packages:
- '@swc/core'
- esbuild
- uglify-js
dev: true
/websocket-driver/0.7.3:
resolution: {integrity: sha512-bpxWlvbbB459Mlipc5GBzzZwhoZgGEZLuqPaR0INBGnPAY1vdBX6hPnoFXiw+3yWxDuHyQjO2oXTMyS8A5haFg==}
......@@ -25545,9 +25529,9 @@ packages:
/zwitch/2.0.4:
resolution: {integrity: sha512-bXE4cR/kVZhKZX/RjPEflHaKVhUVl85noU3v6b8apfQEc1x4A+zBxjZ4lN8LqGd6WZ3dl98pY4o717VFmoPp+A==}
'@gitpkg.vercel.app/vercel/turbo/crates/turbopack-dev/js?turbopack-230321.3_react-refresh@0.12.0':
resolution: {tarball: https://gitpkg.vercel.app/vercel/turbo/crates/turbopack-dev/js?turbopack-230321.3}
id: '@gitpkg.vercel.app/vercel/turbo/crates/turbopack-dev/js?turbopack-230321.3'
'@gitpkg.vercel.app/vercel/turbo/crates/turbopack-dev/js?turbopack-230406.2_react-refresh@0.12.0':
resolution: {tarball: https://gitpkg.vercel.app/vercel/turbo/crates/turbopack-dev/js?turbopack-230406.2}
id: '@gitpkg.vercel.app/vercel/turbo/crates/turbopack-dev/js?turbopack-230406.2'
name: '@vercel/turbopack-dev-runtime'
version: 0.0.0
dependencies:
......
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