Unverified Commit 76083210 authored by Kiko Beats's avatar Kiko Beats Committed by GitHub

Middleware: remove `req.ua` (#37512)

This PR moves the internal logic associated with `req.ua` into an explicit method the user should to call to have the same behavior.

**before**

```typescript
// middleware.ts
import { NextRequest, NextResponse } from 'next/server'
export function middleware(request: NextRequest) {
  const url = request.nextUrl
  const viewport = request.ua.device.type === 'mobile' ? 'mobile' : 'desktop'
  url.searchParams.set('viewport', viewport)
  return NextResponse.rewrites(url)
}
```

**after**

```typescript
// middleware.ts
import { NextRequest, NextResponse, userAgent } from 'next/server'
export function middleware(request: NextRequest) {
  const url = request.nextUrl
  const { device } = userAgent(request)
  const viewport = device.type === 'mobile' ? 'mobile' : 'desktop'
  url.searchParams.set('viewport', viewport)
  return NextResponse.rewrites(url)
}
```

This potentially will save the extra 17 kB related to the size of `ua-parser-js`
parent 0c986cd7
...@@ -673,6 +673,10 @@ ...@@ -673,6 +673,10 @@
{ {
"title": "middleware-request-page.md", "title": "middleware-request-page.md",
"path": "/errors/middleware-request-page.md" "path": "/errors/middleware-request-page.md"
},
{
"title": "middleware-user-agent.md",
"path": "/errors/middleware-user-agent.md"
} }
] ]
} }
......
# Deprecated page into Middleware API # Removed page from Middleware API
#### Why This Error Occurred #### Why This Error Occurred
......
# Removed req.ua from Middleware API
#### Why This Error Occurred
Your middleware is interacting with `req.ua` and this feature needs to opt-in.
```typescript
// middleware.ts
import { NextRequest, NextResponse } from 'next/server'
export function middleware(request: NextRequest) {
const url = request.nextUrl
const viewport = request.ua.device.type === 'mobile' ? 'mobile' : 'desktop'
url.searchParams.set('viewport', viewport)
return NextResponse.rewrites(url)
}
```
#### Possible Ways to Fix It
To parse the user agent, import `userAgent` function from `next/server` and give it your request:
```typescript
// middleware.ts
import { NextRequest, NextResponse, userAgent } from 'next/server'
export function middleware(request: NextRequest) {
const url = request.nextUrl
const { device } = userAgent(request)
const viewport = device.type === 'mobile' ? 'mobile' : 'desktop'
url.searchParams.set('viewport', viewport)
return NextResponse.rewrites(url)
}
```
...@@ -2,3 +2,5 @@ export { NextFetchEvent } from 'next/dist/server/web/spec-extension/fetch-event' ...@@ -2,3 +2,5 @@ export { NextFetchEvent } from 'next/dist/server/web/spec-extension/fetch-event'
export { NextRequest } from 'next/dist/server/web/spec-extension/request' export { NextRequest } from 'next/dist/server/web/spec-extension/request'
export { NextResponse } from 'next/dist/server/web/spec-extension/response' 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 { userAgent } from 'next/dist/server/web/spec-extension/user-agent'
...@@ -3,4 +3,8 @@ module.exports = { ...@@ -3,4 +3,8 @@ module.exports = {
.NextRequest, .NextRequest,
NextResponse: require('next/dist/server/web/spec-extension/response') NextResponse: require('next/dist/server/web/spec-extension/response')
.NextResponse, .NextResponse,
userAgentFromString: require('next/dist/server/web/spec-extension/user-agent')
.userAgentFromString,
userAgent: require('next/dist/server/web/spec-extension/user-agent')
.userAgent,
} }
import type { NextMiddleware, RequestData, FetchEventResult } from './types' import type { NextMiddleware, RequestData, FetchEventResult } from './types'
import type { RequestInit } from './spec-extension/request' import type { RequestInit } from './spec-extension/request'
import { DeprecationSignatureError } from './error' import { PageSignatureError } from './error'
import { fromNodeHeaders } from './utils' import { fromNodeHeaders } from './utils'
import { NextFetchEvent } from './spec-extension/fetch-event' import { NextFetchEvent } from './spec-extension/fetch-event'
import { NextRequest } from './spec-extension/request' import { NextRequest } from './spec-extension/request'
...@@ -162,14 +162,14 @@ class NextRequestHint extends NextRequest { ...@@ -162,14 +162,14 @@ class NextRequestHint extends NextRequest {
} }
get request() { get request() {
throw new DeprecationSignatureError({ page: this.sourcePage }) throw new PageSignatureError({ page: this.sourcePage })
} }
respondWith() { respondWith() {
throw new DeprecationSignatureError({ page: this.sourcePage }) throw new PageSignatureError({ page: this.sourcePage })
} }
waitUntil() { waitUntil() {
throw new DeprecationSignatureError({ page: this.sourcePage }) throw new PageSignatureError({ page: this.sourcePage })
} }
} }
export class DeprecationSignatureError extends Error { export class PageSignatureError extends Error {
constructor({ page }: { page: string }) { constructor({ page }: { page: string }) {
super(`The middleware "${page}" accepts an async API directly with the form: super(`The middleware "${page}" accepts an async API directly with the form:
...@@ -11,10 +11,18 @@ export class DeprecationSignatureError extends Error { ...@@ -11,10 +11,18 @@ export class DeprecationSignatureError extends Error {
} }
} }
export class DeprecationPageError extends Error { export class RemovedPageError extends Error {
constructor() { constructor() {
super(`The request.page has been deprecated in favour of URLPattern. super(`The request.page has been deprecated in favour of \`URLPattern\`.
Read more: https://nextjs.org/docs/messages/middleware-request-page Read more: https://nextjs.org/docs/messages/middleware-request-page
`) `)
} }
} }
export class RemovedUAError extends Error {
constructor() {
super(`The request.page has been removed in favour of \`userAgent\` function.
Read more: https://nextjs.org/docs/messages/middleware-parse-user-agent
`)
}
}
import { DeprecationSignatureError } from '../error' import { PageSignatureError } from '../error'
import { NextRequest } from './request' import { NextRequest } from './request'
const responseSymbol = Symbol('response') const responseSymbol = Symbol('response')
...@@ -42,7 +42,7 @@ export class NextFetchEvent extends FetchEvent { ...@@ -42,7 +42,7 @@ export class NextFetchEvent extends FetchEvent {
* Read more: https://nextjs.org/docs/messages/middleware-new-signature * Read more: https://nextjs.org/docs/messages/middleware-new-signature
*/ */
get request() { get request() {
throw new DeprecationSignatureError({ throw new PageSignatureError({
page: this.sourcePage, page: this.sourcePage,
}) })
} }
...@@ -53,7 +53,7 @@ export class NextFetchEvent extends FetchEvent { ...@@ -53,7 +53,7 @@ export class NextFetchEvent extends FetchEvent {
* Read more: https://nextjs.org/docs/messages/middleware-new-signature * Read more: https://nextjs.org/docs/messages/middleware-new-signature
*/ */
respondWith() { respondWith() {
throw new DeprecationSignatureError({ throw new PageSignatureError({
page: this.sourcePage, page: this.sourcePage,
}) })
} }
......
import type { I18NConfig } from '../../config-shared' import type { I18NConfig } from '../../config-shared'
import type { RequestData } from '../types' import type { RequestData } from '../types'
import { NextURL } from '../next-url' import { NextURL } from '../next-url'
import { isBot } from '../../utils'
import { toNodeHeaders, validateURL } from '../utils' import { toNodeHeaders, validateURL } from '../utils'
import parseua from 'next/dist/compiled/ua-parser-js' import { RemovedUAError, RemovedPageError } from '../error'
import { DeprecationPageError } from '../error'
import { NextCookies } from './cookies' import { NextCookies } from './cookies'
export const INTERNALS = Symbol('internal request') export const INTERNALS = Symbol('internal request')
...@@ -15,7 +12,6 @@ export class NextRequest extends Request { ...@@ -15,7 +12,6 @@ export class NextRequest extends Request {
cookies: NextCookies cookies: NextCookies
geo: RequestData['geo'] geo: RequestData['geo']
ip?: string ip?: string
ua?: UserAgent | null
url: NextURL url: NextURL
} }
...@@ -51,26 +47,11 @@ export class NextRequest extends Request { ...@@ -51,26 +47,11 @@ export class NextRequest extends Request {
} }
public get page() { public get page() {
throw new DeprecationPageError() throw new RemovedPageError()
} }
public get ua() { public get ua() {
if (typeof this[INTERNALS].ua !== 'undefined') { throw new RemovedUAError()
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() { public get url() {
...@@ -91,28 +72,3 @@ export interface RequestInit extends globalThis.RequestInit { ...@@ -91,28 +72,3 @@ export interface RequestInit extends globalThis.RequestInit {
trailingSlash?: boolean trailingSlash?: boolean
} }
} }
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
}
}
import parseua from 'next/dist/compiled/ua-parser-js'
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
}
}
export function isBot(input: string): boolean {
return /Googlebot|Mediapartners-Google|AdsBot-Google|googleweblight|Storebot-Google|Google-PageRenderer|Bingbot|BingPreview|Slurp|DuckDuckBot|baiduspider|yandex|sogou|LinkedInBot|bitlybot|tumblr|vkShare|quora link preview|facebookexternalhit|facebookcatalog|Twitterbot|applebot|redditbot|Slackbot|Discordbot|WhatsApp|SkypeUriPreview|ia_archiver/i.test(
input
)
}
export function userAgentFromString(input: string | undefined): UserAgent {
return {
...parseua(input),
isBot: input === undefined ? false : isBot(input),
}
}
export function userAgent({ headers }: { headers: Headers }): UserAgent {
return userAgentFromString(headers.get('user-agent') || undefined)
}
/**
* @jest-environment @edge-runtime/jest-environment
*/
import { userAgentFromString, userAgent, NextRequest } from 'next/server'
const UA_STRING =
'Mozilla/5.0 (Macintosh; Intel Mac OS X 11_2_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.90 Safari/537.36'
it('parse an user agent', () => {
const parser = userAgentFromString(UA_STRING)
expect(parser.ua).toBe(
'Mozilla/5.0 (Macintosh; Intel Mac OS X 11_2_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.90 Safari/537.36'
)
expect(parser.browser).toStrictEqual({
name: 'Chrome',
version: '89.0.4389.90',
major: '89',
})
expect(parser.engine).toStrictEqual({
name: 'Blink',
version: '89.0.4389.90',
})
expect(parser.os).toStrictEqual({ name: 'Mac OS', version: '11.2.3' })
expect(parser.cpu).toStrictEqual({ architecture: undefined })
expect(parser.isBot).toBe(false)
})
it('parse empty user agent', () => {
expect.assertions(3)
for (const input of [undefined, null, '']) {
expect(userAgentFromString(input)).toStrictEqual({
ua: '',
browser: { name: undefined, version: undefined, major: undefined },
engine: { name: undefined, version: undefined },
os: { name: undefined, version: undefined },
device: { vendor: undefined, model: undefined, type: undefined },
cpu: { architecture: undefined },
isBot: false,
})
}
})
it('parse user agent from a NextRequest instance', () => {
const request = new NextRequest('https://vercel.com', {
headers: {
'user-agent': UA_STRING,
},
})
expect(userAgent(request)).toStrictEqual({
ua: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 11_2_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.90 Safari/537.36',
browser: { name: 'Chrome', version: '89.0.4389.90', major: '89' },
engine: { name: 'Blink', version: '89.0.4389.90' },
os: { name: 'Mac OS', version: '11.2.3' },
device: { vendor: undefined, model: undefined, type: undefined },
cpu: { architecture: undefined },
isBot: false,
})
})
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