rsnext/packages/next/server/web/spec-extension/request.ts
Kiko Beats fafbea8b74
Use Edge Runtime for running Edge Functions locally (#37024)
This PR introduces [Edge Runtime](https://edge-runtime.vercel.app/) for emulating [Edge Functions](https://vercel.com/features/edge-functions) locally.

Every time you run a [middleware](https://nextjs.org/docs/advanced-features/middleware) locally via `next dev`, an isolated edge runtime context will be created.

These contexts have the same constraints as production servers, plus they don't pollute the global scope; Instead, all the code run in a vm on top of a Node.js process.

Additionally, `@edge-runtime/jest-environment` has been added to make easier testing Edge Functions in a programmatic way.

It dropped the following polyfills from Next.js codebase, since they are now part of Edge Runtime:

- abort-controller
- formdata
- uuid
- web-crypto
- web-streams

Co-authored-by: Gal Schlezinger <2054772+Schniz@users.noreply.github.com>
2022-05-30 12:01:36 +00:00

130 lines
2.6 KiB
TypeScript

import type { I18NConfig } from '../../config-shared'
import type { RequestData } from '../types'
import { NextURL } from '../next-url'
import { isBot } from '../../utils'
import { toNodeHeaders, validateURL } from '../utils'
import parseua from 'next/dist/compiled/ua-parser-js'
import { NextCookies } from './cookies'
export const INTERNALS = Symbol('internal request')
export class NextRequest extends Request {
[INTERNALS]: {
cookies: NextCookies
geo: RequestData['geo']
ip?: string
page?: { name?: string; params?: { [key: string]: string | string[] } }
ua?: UserAgent | null
url: NextURL
}
constructor(input: Request | string, init: RequestInit = {}) {
const url = typeof input === 'string' ? input : input.url
validateURL(url)
super(input, init)
this[INTERNALS] = {
cookies: new NextCookies(this),
geo: init.geo || {},
ip: init.ip,
page: init.page,
url: new NextURL(url, {
headers: toNodeHeaders(this.headers),
nextConfig: init.nextConfig,
}),
}
}
public get cookies() {
return this[INTERNALS].cookies
}
public get geo() {
return this[INTERNALS].geo
}
public get ip() {
return this[INTERNALS].ip
}
public get preflight() {
return this.headers.get('x-middleware-preflight')
}
public get nextUrl() {
return this[INTERNALS].url
}
public get page() {
return {
name: this[INTERNALS].page?.name,
params: this[INTERNALS].page?.params,
}
}
public get ua() {
if (typeof this[INTERNALS].ua !== 'undefined') {
return this[INTERNALS].ua || undefined
}
const uaString = this.headers.get('user-agent')
if (!uaString) {
this[INTERNALS].ua = null
return this[INTERNALS].ua || undefined
}
this[INTERNALS].ua = {
...parseua(uaString),
isBot: isBot(uaString),
}
return this[INTERNALS].ua
}
public get url() {
return this[INTERNALS].url.toString()
}
}
export interface RequestInit extends globalThis.RequestInit {
geo?: {
city?: string
country?: string
region?: string
}
ip?: string
nextConfig?: {
basePath?: string
i18n?: I18NConfig | null
trailingSlash?: boolean
}
page?: {
name?: string
params?: { [key: string]: string | string[] }
}
}
interface UserAgent {
isBot: boolean
ua: string
browser: {
name?: string
version?: string
}
device: {
model?: string
type?: string
vendor?: string
}
engine: {
name?: string
version?: string
}
os: {
name?: string
version?: string
}
cpu: {
architecture?: string
}
}