Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Helpers update #7686

Merged
merged 8 commits into from
Jun 28, 2019
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions examples/with-webassembly/Cargo.toml

This file was deleted.

82 changes: 67 additions & 15 deletions packages/next-server/server/api-utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,15 @@ import { IncomingMessage } from 'http'
import { NextApiResponse, NextApiRequest } from '../lib/utils'
import { Stream } from 'stream'
import getRawBody from 'raw-body'
import { URL } from 'url'
import { parse } from 'content-type'
import { Params } from './router'

export type NextApiRequestCookies = { [key: string]: string }
export type NextApiRequestQuery = { [key: string]: string | string[] }

/**
* Parse incoming message like `json` or `urlencoded`
* @param req
* @param req request object
*/
export async function parseBody(req: NextApiRequest, limit: string = '1mb') {
const contentType = parse(req.headers['content-type'] || 'text/plain')
Expand Down Expand Up @@ -56,13 +59,34 @@ function parseJson(str: string) {
* @returns Object with key name of query argument and its value
*/
export function parseQuery({ url }: IncomingMessage) {
huv1k marked this conversation as resolved.
Show resolved Hide resolved
if (url) {
// This is just for parsing search params, base it's not important
return function parseQuery(): NextApiRequestQuery {
const { URL } = require('url')
// we provide a placeholder base url because we only want searchParams
const params = new URL(url, 'https://n').searchParams

return reduceParams(params.entries())
} else {
return {}
const query: { [key: string]: string | string[] } = {}
for (const [key, value] of params) {
query[key] = value
}

return query
}
}

/**
* Parse cookeies from `req` header
* @param req request object
*/
export function getCookieParser(req: IncomingMessage) {
return function parseCookie(): NextApiRequestCookies {
const header: undefined | string | string[] = req.headers.cookie

if (!header) {
return {}
}

const { parse } = require('cookie')
return parse(Array.isArray(header) ? header.join(';') : header)
}
}

Expand Down Expand Up @@ -131,14 +155,6 @@ export function sendJson(res: NextApiResponse, jsonBody: any): void {
res.send(jsonBody)
}

function reduceParams(params: IterableIterator<[string, string]>) {
const obj: any = {}
for (const [key, value] of params) {
obj[key] = value
}
return obj
}

/**
* Custom error class
*/
Expand Down Expand Up @@ -166,3 +182,39 @@ export function sendError(
res.statusMessage = message
res.end()
}

interface LazyProps {
req: NextApiRequest
params?: Params | boolean
}

/**
* Execute getter function only if its needed
* @param LazyProps `req` and `params` for lazyProp
* @param prop name of property
* @param getter function to get data
*/
export function setLazyProp<T>(
{ req, params }: LazyProps,
prop: string,
getter: () => T
) {
const opts = { configurable: true, enumerable: true }
const optsReset = { ...opts, writable: true }

Object.defineProperty(req, prop, {
...opts,
get: () => {
let value = getter()
if (params && typeof params !== 'boolean') {
value = { ...value, ...params }
}
// we set the property on the object to avoid recalculating it
Object.defineProperty(req, prop, { ...optsReset, value })
return value
},
set: value => {
Object.defineProperty(req, prop, { ...optsReset, value })
},
})
}
3 changes: 3 additions & 0 deletions packages/next-server/server/load-components.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ export function interopDefault(mod: any) {

export interface IPageConfig {
amp?: boolean | 'hybrid'
api?: {
bodyParser?: boolean
}
}

export type LoadComponentsReturnType = {
Expand Down
23 changes: 18 additions & 5 deletions packages/next-server/server/next-server.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ import {
} from '../lib/router/utils'
import * as envConfig from '../lib/runtime-config'
import { NextApiRequest, NextApiResponse } from '../lib/utils'
import { parse as parseCookies } from 'cookie'
import {
parseQuery,
sendJson,
Expand All @@ -32,13 +31,16 @@ import {
sendError,
ApiError,
sendStatusCode,
setLazyProp,
getCookieParser,
} from './api-utils'
import loadConfig from './config'
import { recursiveReadDirSync } from './lib/recursive-readdir-sync'
import {
interopDefault,
loadComponents,
LoadComponentsReturnType,
IPageConfig,
} from './load-components'
import { renderToHTML } from './render'
import { getPagePath } from './require'
Expand Down Expand Up @@ -289,6 +291,7 @@ export default class Server {
res: NextApiResponse,
pathname: string
) {
let bodyParser = true
let params: Params | boolean = false

let resolverFunction = await this.resolveApiRequest(pathname)
Expand All @@ -313,18 +316,28 @@ export default class Server {
}

try {
const resolverModule = require(resolverFunction)

if (resolverModule.config) {
const config: IPageConfig = resolverModule.config
if (config.api && !config.api.bodyParser) {
huv1k marked this conversation as resolved.
Show resolved Hide resolved
bodyParser = false
}
}
// Parsing of cookies
req.cookies = parseCookies(req.headers.cookie || '')
setLazyProp({ req }, 'cookies', getCookieParser(req))
// Parsing query string
req.query = { ...parseQuery(req), ...params }
setLazyProp({ req, params }, 'query', parseQuery(req))
// // Parsing of body
req.body = await parseBody(req)
if (bodyParser) {
req.body = await parseBody(req)
}

res.status = statusCode => sendStatusCode(res, statusCode)
res.send = data => sendData(res, data)
res.json = data => sendJson(res, data)

const resolver = interopDefault(require(resolverFunction))
const resolver = interopDefault(resolverModule)
resolver(req, res)
} catch (e) {
if (e instanceof ApiError) {
Expand Down
3 changes: 3 additions & 0 deletions packages/next/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,9 @@ export type NextPage<P = {}, IP = P> = {
*/
export type PageConfig = {
amp?: boolean | 'hybrid'
api?: {
bodyParser?: boolean
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The problem with having a static export is that it always has to be configure by the user. Third party libraries can't configure the handlers they produce to opt out of this body-parser. e.g. if I create a proxy library, I'd have to ask my users to always include this static export:

import someProxy from 'third-party';
export default someProxy();
// I'd have to ask users of my library to include the following or it won't work:
export const {
  api: {
    bodyParser: false
  }
}

}
}

export { NextPageContext, NextComponentType, NextApiResponse, NextApiRequest }
18 changes: 18 additions & 0 deletions test/integration/api-support/pages/api/no-parsing.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
export const config = {
api: {
bodyParser: false
}
}

export default (req, res) => {
if (!req.body) {
let buffer = ''
req.on('data', chunk => {
buffer += chunk
})

req.on('end', () => {
res.status(200).json(JSON.parse(Buffer.from(buffer).toString()))
})
}
}
11 changes: 11 additions & 0 deletions test/integration/api-support/pages/api/parsing.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
export const config = {
api: {
bodyParser: true
}
}

export default (req, res) => {
if (req.body) {
res.status(200).json({ message: 'Parsed body' })
}
}
24 changes: 24 additions & 0 deletions test/integration/api-support/test/index.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,30 @@ function runTests (serverless = false) {
})
})

it('should parse body in handler', async () => {
const data = await fetchViaHTTP(appPort, '/api/no-parsing', null, {
method: 'POST',
headers: {
'Content-Type': 'application/json; charset=utf-8'
},
body: JSON.stringify([{ title: 'Nextjs' }])
}).then(res => res.ok && res.json())

expect(data).toEqual([{ title: 'Nextjs' }])
})

it('should parse body with config', async () => {
const data = await fetchViaHTTP(appPort, '/api/parsing', null, {
method: 'POST',
headers: {
'Content-Type': 'application/json; charset=utf-8'
},
body: JSON.stringify([{ title: 'Nextjs' }])
}).then(res => res.ok && res.json())

expect(data).toEqual({ message: 'Parsed body' })
})

it('should return empty cookies object', async () => {
const data = await fetchViaHTTP(appPort, '/api/cookies', null, {}).then(
res => res.ok && res.json()
Expand Down