Unverified Commit e3181c2d authored by Gal Schlezinger's avatar Gal Schlezinger Committed by GitHub

Export URLPattern from next/server (#39219)

This commit allows the users to import URLPattern from `next/server`,
by defining a key that uses `global.URLPattern`.

Why is this any good? or: why don't we add URLPattern to the global namespace?

URLPattern is exposed as global on Edge Runtime _only_. This means that if we define a
constructor in global namespace in our TypeScript definitions, people might
have runtime errors in their Node.js functions.

Importing from `next/server` enables users to get the constructor without
risking in runtime errors and wrong type definitions.

Keep in mind, that with the current implementation, we do not check if the
constructor actually exists, but `next/server` shouldn't be imported in
Node.js functions, AFAIK.

## Related

- Fixes #38131

## Bug

- [x] Related issues linked using `fixes #number`
- [ ] Integration tests added
- [ ] Errors have helpful link attached, see `contributing.md`
Co-authored-by: 's avatarJJ Kasper <22380829+ijjk@users.noreply.github.com>
parent ad75204b
...@@ -56,7 +56,7 @@ ...@@ -56,7 +56,7 @@
"@babel/plugin-proposal-object-rest-spread": "7.14.7", "@babel/plugin-proposal-object-rest-spread": "7.14.7",
"@babel/preset-flow": "7.14.5", "@babel/preset-flow": "7.14.5",
"@babel/preset-react": "7.14.5", "@babel/preset-react": "7.14.5",
"@edge-runtime/jest-environment": "1.1.0-beta.23", "@edge-runtime/jest-environment": "1.1.0-beta.25",
"@fullhuman/postcss-purgecss": "1.3.0", "@fullhuman/postcss-purgecss": "1.3.0",
"@mdx-js/loader": "0.18.0", "@mdx-js/loader": "0.18.0",
"@next/bundle-analyzer": "workspace:*", "@next/bundle-analyzer": "workspace:*",
......
declare const AbortControllerConstructor: typeof AbortController
declare const AbortSignalConstructor: typeof AbortSignal
export { AbortControllerConstructor as AbortController, AbortSignalConstructor as AbortSignal };
{"main":"../abort-controller.js"} {"main":"../abort-controller.js","types":"../abort-controller.d.ts"}
declare const BlobConstructor: typeof Blob
export { BlobConstructor as Blob };
{"main":"../blob.js"} {"main":"../blob.js","types":"../blob.d.ts"}
declare function createCaches(): {
cacheStorage: () => CacheStorage
Cache: typeof Cache
CacheStorage: typeof CacheStorage
}
declare const caches: CacheStorage
declare const CacheStorageConstructor: typeof CacheStorage
declare const CacheConstructor: typeof Cache
export { CacheConstructor as Cache, CacheStorageConstructor as CacheStorage, caches, createCaches };
{"main":"../cache.js"} {"main":"../cache.js","types":"../cache.d.ts"}
interface IConsole {
assert: Console['assert']
count: Console['count']
debug: Console['debug']
dir: Console['dir']
error: Console['error']
info: Console['info']
log: Console['log']
time: Console['time']
timeEnd: Console['timeEnd']
timeLog: Console['timeLog']
trace: Console['trace']
warn: Console['warn']
}
declare const console: IConsole
export { console };
{"main":"../console.js"} {"main":"../console.js","types":"../console.d.ts"}
declare const crypto: Crypto
declare const CryptoConstructor: typeof Crypto
declare const CryptoKeyConstructor: typeof CryptoKey
declare const SubtleCryptoConstructor: typeof SubtleCrypto
export { CryptoConstructor as Crypto, CryptoKeyConstructor as CryptoKey, SubtleCryptoConstructor as SubtleCrypto, crypto };
{"main":"../crypto.js"} {"main":"../crypto.js","types":"../crypto.d.ts"}
declare const TextEncoderConstructor: typeof TextEncoder
declare const TextDecoderConstructor: typeof TextDecoder
declare const atob: (encoded: string) => string
declare const btoa: (str: string) => string
export { TextDecoderConstructor as TextDecoder, TextEncoderConstructor as TextEncoder, atob, btoa };
{"main":"../encoding.js"} {"main":"../encoding.js","types":"../encoding.d.ts"}
This diff is collapsed.
{"main":"../events.js"} {"main":"../events.js","types":"../events.d.ts"}
declare class Headers extends globalThis.Headers {
getAll(key: 'set-cookie'): string[]
}
declare class Request extends globalThis.Request {
readonly headers: Headers
}
declare class Response extends globalThis.Response {
readonly headers: Headers
}
declare const fetchImplementation: typeof fetch
declare const FileConstructor: typeof File
declare const FormDataConstructor: typeof FormData
export { FileConstructor as File, FormDataConstructor as FormData, Headers, Request, Response, fetchImplementation as fetch };
...@@ -6658,6 +6658,7 @@ var import_request = __toESM(require_request()); ...@@ -6658,6 +6658,7 @@ var import_request = __toESM(require_request());
var import_file = __toESM(require_file()); var import_file = __toESM(require_file());
global.AbortController = import_abort_controller.AbortController; global.AbortController = import_abort_controller.AbortController;
global.AbortSignal = import_abort_controller2.AbortSignal; global.AbortSignal = import_abort_controller2.AbortSignal;
define_process_default.nextTick = setImmediate;
var SCookies = Symbol("set-cookie"); var SCookies = Symbol("set-cookie");
var __append = HeadersModule.HeadersList.prototype.append; var __append = HeadersModule.HeadersList.prototype.append;
HeadersModule.HeadersList.prototype.append = function(name, value) { HeadersModule.HeadersList.prototype.append = function(name, value) {
......
{"main":"../fetch.js"} {"main":"../fetch.js","types":"../fetch.d.ts"}
{"name":"@edge-runtime/primitives","version":"1.1.0-beta.23","main":"./index.js","license":"MPLv2"} {"name":"@edge-runtime/primitives","version":"1.1.0-beta.25","main":"./index.js","license":"MPLv2"}
/**
* The type of `ReadableStreamBYOBReader` is not included in Typescript so we
* are declaring it inline to not have to worry about bundling.
*/
declare class ReadableStreamBYOBReader {
constructor(stream: ReadableStream<Uint8Array>)
get closed(): Promise<undefined>
cancel(reason?: any): Promise<void>
read<T extends ArrayBufferView>(
view: T
): Promise<{ done: false; value: T } | { done: true; value: T | undefined }>
releaseLock(): void
}
declare const ReadableStreamConstructor: typeof ReadableStream
declare const ReadableStreamBYOBReaderConstructor: typeof ReadableStreamBYOBReader
declare const ReadableStreamDefaultReaderConstructor: typeof ReadableStreamDefaultReader
declare const TransformStreamConstructor: typeof TransformStream
declare const WritableStreamConstructor: typeof WritableStream
declare const WritableStreamDefaultWriterConstructor: typeof WritableStreamDefaultWriter
export { ReadableStreamConstructor as ReadableStream, ReadableStreamBYOBReaderConstructor as ReadableStreamBYOBReader, ReadableStreamDefaultReaderConstructor as ReadableStreamDefaultReader, TransformStreamConstructor as TransformStream, WritableStreamConstructor as WritableStream, WritableStreamDefaultWriterConstructor as WritableStreamDefaultWriter };
{"main":"../streams.js"} {"main":"../streams.js","types":"../streams.d.ts"}
declare const structuredClone: <T>(any: T, options?: { lossy?: boolean }) => T
export { structuredClone };
{"main":"../structured-clone.js"} {"main":"../structured-clone.js","types":"../structured-clone.d.ts"}
type URLPatternInput = URLPatternInit | string
declare class URLPattern {
constructor(init?: URLPatternInput, baseURL?: string)
test(input?: URLPatternInput, baseURL?: string): boolean
exec(input?: URLPatternInput, baseURL?: string): URLPatternResult | null
readonly protocol: string
readonly username: string
readonly password: string
readonly hostname: string
readonly port: string
readonly pathname: string
readonly search: string
readonly hash: string
}
interface URLPatternInit {
baseURL?: string
username?: string
password?: string
protocol?: string
hostname?: string
port?: string
pathname?: string
search?: string
hash?: string
}
interface URLPatternResult {
inputs: [URLPatternInput]
protocol: URLPatternComponentResult
username: URLPatternComponentResult
password: URLPatternComponentResult
hostname: URLPatternComponentResult
port: URLPatternComponentResult
pathname: URLPatternComponentResult
search: URLPatternComponentResult
hash: URLPatternComponentResult
}
interface URLPatternComponentResult {
input: string
groups: {
[key: string]: string | undefined
}
}
declare const URLPatternConstructor: typeof URLPattern
declare const URLConstructor: typeof URL
declare const URLSearchParamsConstructor: typeof URLSearchParams
export { URLConstructor as URL, URLPatternConstructor as URLPattern, URLSearchParamsConstructor as URLSearchParams };
{"main":"../url.js"} {"main":"../url.js","types":"../url.d.ts"}
...@@ -117,7 +117,7 @@ ...@@ -117,7 +117,7 @@
"@babel/runtime": "7.15.4", "@babel/runtime": "7.15.4",
"@babel/traverse": "7.18.0", "@babel/traverse": "7.18.0",
"@babel/types": "7.18.0", "@babel/types": "7.18.0",
"@edge-runtime/primitives": "1.1.0-beta.23", "@edge-runtime/primitives": "1.1.0-beta.25",
"@hapi/accept": "5.0.2", "@hapi/accept": "5.0.2",
"@napi-rs/cli": "2.7.0", "@napi-rs/cli": "2.7.0",
"@napi-rs/triples": "1.1.0", "@napi-rs/triples": "1.1.0",
...@@ -194,7 +194,7 @@ ...@@ -194,7 +194,7 @@
"debug": "4.1.1", "debug": "4.1.1",
"devalue": "2.0.1", "devalue": "2.0.1",
"domain-browser": "4.19.0", "domain-browser": "4.19.0",
"edge-runtime": "1.1.0-beta.23", "edge-runtime": "1.1.0-beta.25",
"events": "3.3.0", "events": "3.3.0",
"find-cache-dir": "3.3.1", "find-cache-dir": "3.3.1",
"find-up": "4.1.0", "find-up": "4.1.0",
......
...@@ -4,3 +4,4 @@ export { NextResponse } from 'next/dist/server/web/spec-extension/response' ...@@ -4,3 +4,4 @@ export { NextResponse } from 'next/dist/server/web/spec-extension/response'
export { NextMiddleware } from 'next/dist/server/web/types' export { NextMiddleware } from 'next/dist/server/web/types'
export { userAgentFromString } from 'next/dist/server/web/spec-extension/user-agent' export { userAgentFromString } from 'next/dist/server/web/spec-extension/user-agent'
export { userAgent } from 'next/dist/server/web/spec-extension/user-agent' export { userAgent } from 'next/dist/server/web/spec-extension/user-agent'
export { URLPattern } from 'next/dist/compiled/@edge-runtime/primitives/url'
...@@ -7,4 +7,5 @@ module.exports = { ...@@ -7,4 +7,5 @@ module.exports = {
.userAgentFromString, .userAgentFromString,
userAgent: require('next/dist/server/web/spec-extension/user-agent') userAgent: require('next/dist/server/web/spec-extension/user-agent')
.userAgent, .userAgent,
URLPattern: global.URLPattern,
} }
...@@ -254,12 +254,17 @@ export async function ncc_edge_runtime_primitives() { ...@@ -254,12 +254,17 @@ export async function ncc_edge_runtime_primitives() {
const dest2 = `compiled/@edge-runtime/primitives/${file}` const dest2 = `compiled/@edge-runtime/primitives/${file}`
await fs.outputJson(join(dest2, 'package.json'), { await fs.outputJson(join(dest2, 'package.json'), {
main: `../${file}.js`, main: `../${file}.js`,
types: `../${file}.d.ts`,
}) })
await fs.copy( await fs.copy(
require.resolve(`@edge-runtime/primitives/${file}`), require.resolve(`@edge-runtime/primitives/${file}`),
join(dest, `${file}.js`) join(dest, `${file}.js`)
) )
await fs.copy(
require.resolve(`@edge-runtime/primitives/types/${file}.d.ts`),
join(dest, `${file}.d.ts`)
)
} }
await fs.outputJson(join(dest, 'package.json'), { await fs.outputJson(join(dest, 'package.json'), {
......
...@@ -19,7 +19,7 @@ importers: ...@@ -19,7 +19,7 @@ importers:
'@babel/plugin-proposal-object-rest-spread': 7.14.7 '@babel/plugin-proposal-object-rest-spread': 7.14.7
'@babel/preset-flow': 7.14.5 '@babel/preset-flow': 7.14.5
'@babel/preset-react': 7.14.5 '@babel/preset-react': 7.14.5
'@edge-runtime/jest-environment': 1.1.0-beta.23 '@edge-runtime/jest-environment': 1.1.0-beta.25
'@fullhuman/postcss-purgecss': 1.3.0 '@fullhuman/postcss-purgecss': 1.3.0
'@mdx-js/loader': 0.18.0 '@mdx-js/loader': 0.18.0
'@next/bundle-analyzer': workspace:* '@next/bundle-analyzer': workspace:*
...@@ -172,7 +172,7 @@ importers: ...@@ -172,7 +172,7 @@ importers:
'@babel/plugin-proposal-object-rest-spread': 7.14.7_@babel+core@7.18.0 '@babel/plugin-proposal-object-rest-spread': 7.14.7_@babel+core@7.18.0
'@babel/preset-flow': 7.14.5_@babel+core@7.18.0 '@babel/preset-flow': 7.14.5_@babel+core@7.18.0
'@babel/preset-react': 7.14.5_@babel+core@7.18.0 '@babel/preset-react': 7.14.5_@babel+core@7.18.0
'@edge-runtime/jest-environment': 1.1.0-beta.23 '@edge-runtime/jest-environment': 1.1.0-beta.25
'@fullhuman/postcss-purgecss': 1.3.0 '@fullhuman/postcss-purgecss': 1.3.0
'@mdx-js/loader': 0.18.0_uuaxwgga6hqycsez5ok7v2wg4i '@mdx-js/loader': 0.18.0_uuaxwgga6hqycsez5ok7v2wg4i
'@next/bundle-analyzer': link:packages/next-bundle-analyzer '@next/bundle-analyzer': link:packages/next-bundle-analyzer
...@@ -414,7 +414,7 @@ importers: ...@@ -414,7 +414,7 @@ importers:
'@babel/runtime': 7.15.4 '@babel/runtime': 7.15.4
'@babel/traverse': 7.18.0 '@babel/traverse': 7.18.0
'@babel/types': 7.18.0 '@babel/types': 7.18.0
'@edge-runtime/primitives': 1.1.0-beta.23 '@edge-runtime/primitives': 1.1.0-beta.25
'@hapi/accept': 5.0.2 '@hapi/accept': 5.0.2
'@napi-rs/cli': 2.7.0 '@napi-rs/cli': 2.7.0
'@napi-rs/triples': 1.1.0 '@napi-rs/triples': 1.1.0
...@@ -494,7 +494,7 @@ importers: ...@@ -494,7 +494,7 @@ importers:
debug: 4.1.1 debug: 4.1.1
devalue: 2.0.1 devalue: 2.0.1
domain-browser: 4.19.0 domain-browser: 4.19.0
edge-runtime: 1.1.0-beta.23 edge-runtime: 1.1.0-beta.25
events: 3.3.0 events: 3.3.0
find-cache-dir: 3.3.1 find-cache-dir: 3.3.1
find-up: 4.1.0 find-up: 4.1.0
...@@ -607,7 +607,7 @@ importers: ...@@ -607,7 +607,7 @@ importers:
'@babel/runtime': 7.15.4 '@babel/runtime': 7.15.4
'@babel/traverse': 7.18.0 '@babel/traverse': 7.18.0
'@babel/types': 7.18.0 '@babel/types': 7.18.0
'@edge-runtime/primitives': 1.1.0-beta.23 '@edge-runtime/primitives': 1.1.0-beta.25
'@hapi/accept': 5.0.2 '@hapi/accept': 5.0.2
'@napi-rs/cli': 2.7.0 '@napi-rs/cli': 2.7.0
'@napi-rs/triples': 1.1.0 '@napi-rs/triples': 1.1.0
...@@ -684,7 +684,7 @@ importers: ...@@ -684,7 +684,7 @@ importers:
debug: 4.1.1 debug: 4.1.1
devalue: 2.0.1 devalue: 2.0.1
domain-browser: 4.19.0 domain-browser: 4.19.0
edge-runtime: 1.1.0-beta.23 edge-runtime: 1.1.0-beta.25
events: 3.3.0 events: 3.3.0
find-cache-dir: 3.3.1 find-cache-dir: 3.3.1
find-up: 4.1.0 find-up: 4.1.0
...@@ -3214,14 +3214,14 @@ packages: ...@@ -3214,14 +3214,14 @@ packages:
protobufjs: 6.11.2 protobufjs: 6.11.2
dev: true dev: true
/@edge-runtime/format/1.1.0-beta.23: /@edge-runtime/format/1.1.0-beta.25:
resolution: {integrity: sha512-TuY7ywLzp2XQQZpM8cX1dzm2QMK2juvtpMVR8K61utL2qvokzJ4gBYLcPSKhH0EWAt4WwgymNVRX0cpdSLAqAg==} resolution: {integrity: sha512-7fzTXgfVzcWs6T8ePVyogbVU67TbXpDHhgop9yP9stsRlejJjD2bDm/jDwX9XAfQdET5gVaKDiYc0wkp9E4gig==}
dev: true dev: true
/@edge-runtime/jest-environment/1.1.0-beta.23: /@edge-runtime/jest-environment/1.1.0-beta.25:
resolution: {integrity: sha512-mQ5Vst9k44umfsR90mLy6DqatEPBOiU25T1mtKdmyuQVXhvcH2+3oevTu6/aPW/5J489ZXp60BDWfye4lQD7ew==} resolution: {integrity: sha512-tOjxI0/8m0beqEiOXmDzPCqpycUiMLvIV1PoQ9zb5qcxJqF8AcmZMRqICfdqnWo+P3qJIr8YeZSG31lz5EaJfw==}
dependencies: dependencies:
'@edge-runtime/vm': 1.1.0-beta.23 '@edge-runtime/vm': 1.1.0-beta.25
'@jest/environment': 28.1.3 '@jest/environment': 28.1.3
'@jest/fake-timers': 28.1.3 '@jest/fake-timers': 28.1.3
'@jest/types': 28.1.3 '@jest/types': 28.1.3
...@@ -3229,14 +3229,14 @@ packages: ...@@ -3229,14 +3229,14 @@ packages:
jest-util: 28.1.3 jest-util: 28.1.3
dev: true dev: true
/@edge-runtime/primitives/1.1.0-beta.23: /@edge-runtime/primitives/1.1.0-beta.25:
resolution: {integrity: sha512-0vHcZZwyxjmw/so9irYtA82/+nAlJRs+1WpRYBx7iae1FOGCPM4BIKEmboWmwTuj7c6avz9kIbptokdMUPgV9A==} resolution: {integrity: sha512-+lKore2sAuGD2AMa2GZviLMHKfFmw5k2BzhvyatKPuJ/frIFpb1OdluxGHfqmVBtNIJwnn7IJoJd9jm8r/6Flg==}
dev: true dev: true
/@edge-runtime/vm/1.1.0-beta.23: /@edge-runtime/vm/1.1.0-beta.25:
resolution: {integrity: sha512-XBp3rCuX4scJVOo2KconAotL5XGX3zdd8IkfDNr5VVSQ/B6HkiTNuf+EvzSQTpplF+fiyLTpfcP9EbNLibwLTA==} resolution: {integrity: sha512-xDre6a3L0KXsxQxuZaXw5ukyGh5v7k1E7XL5ooxBbaHz+5GtvCidSZ3sPvFDzetlKq7eBT4ztg4RTkHbCUclDA==}
dependencies: dependencies:
'@edge-runtime/primitives': 1.1.0-beta.23 '@edge-runtime/primitives': 1.1.0-beta.25
dev: true dev: true
/@emotion/is-prop-valid/0.8.8: /@emotion/is-prop-valid/0.8.8:
...@@ -9968,12 +9968,12 @@ packages: ...@@ -9968,12 +9968,12 @@ packages:
safe-buffer: 5.2.0 safe-buffer: 5.2.0
dev: true dev: true
/edge-runtime/1.1.0-beta.23: /edge-runtime/1.1.0-beta.25:
resolution: {integrity: sha512-A7dO/Y+4UJnaxFcdz6pepL+0GcvvViWvf201oFQXepgdSxPDKiqxaayCag0eiirQ6OfF+cSTmPD3xrfEoAIjiQ==} resolution: {integrity: sha512-2yC0hqnMis0t2zIFCWsV7uu8hEhUZDgVszZyXS/C4719r1km2FkL5kWk+6ktVD4A6fUTnzTrYPq+fzTxIt7X2A==}
hasBin: true hasBin: true
dependencies: dependencies:
'@edge-runtime/format': 1.1.0-beta.23 '@edge-runtime/format': 1.1.0-beta.25
'@edge-runtime/vm': 1.1.0-beta.23 '@edge-runtime/vm': 1.1.0-beta.25
exit-hook: 2.2.1 exit-hook: 2.2.1
http-status: 1.5.2 http-status: 1.5.2
mri: 1.2.0 mri: 1.2.0
...@@ -10431,6 +10431,7 @@ packages: ...@@ -10431,6 +10431,7 @@ packages:
eslint: ^3.0.0 || ^4.0.0 || ^5.0.0 || ^6.0.0 || ^7.0.0 || ^8.0.0-0 eslint: ^3.0.0 || ^4.0.0 || ^5.0.0 || ^6.0.0 || ^7.0.0 || ^8.0.0-0
dependencies: dependencies:
eslint: 7.32.0 eslint: 7.32.0
dev: false
/eslint-plugin-react/7.23.2_eslint@7.24.0: /eslint-plugin-react/7.23.2_eslint@7.24.0:
resolution: {integrity: sha512-AfjgFQB+nYszudkxRkTFu0UR1zEQig0ArVMPloKhxwlwkzaw/fBiH0QWcBBhZONlXqQC51+nfqFrkn4EzHcGBw==} resolution: {integrity: sha512-AfjgFQB+nYszudkxRkTFu0UR1zEQig0ArVMPloKhxwlwkzaw/fBiH0QWcBBhZONlXqQC51+nfqFrkn4EzHcGBw==}
......
/* global globalThis, URLPattern */ /* global globalThis */
import { NextRequest, NextResponse } from 'next/server' import { NextRequest, NextResponse, URLPattern } from 'next/server'
import magicValue from 'shared-package' import magicValue from 'shared-package'
const PATTERNS = [ const PATTERNS = [
......
/* global URLPattern */ import { NextResponse, URLPattern } from 'next/server'
import { NextResponse } from 'next/server'
export async function middleware(request) { export async function middleware(request) {
const url = request.nextUrl const url = request.nextUrl
......
import { NextMiddleware, NextResponse } from 'next/server' import { NextMiddleware, NextResponse, URLPattern } from 'next/server'
export const middleware: NextMiddleware = function (request) { export const middleware: NextMiddleware = function (request) {
const pattern = new URLPattern({
pathname: '/:path',
})
console.log(pattern.test(request.nextUrl.pathname))
if (request.nextUrl.pathname === '/static') { if (request.nextUrl.pathname === '/static') {
return new NextResponse(null, { return new NextResponse(null, {
headers: { headers: {
......
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